Error handling
The configuration of error handling is done under “Settings” - “Error Handling”.
...
You will then see a list of predefined error categories. Each category can be opened by clicking the arrow next to the category label.
...
As an example under “Category: DeveloperErrors” there has been set a “Category default” to stakeholder “BIZbrains Support”. BIZbrains Support will be the receiver of the error notification e-mail related to all developer related errors. All the various developer errors are listed below the “Category: DeveloperErrors” and could e.g., be the error “14001 BizTalk tried to use a map that was not installed.”. That error message would appear in the e-mail to the stakeholder.
If you click Edit at the right on the line you will see how the Error notification is set up.
...
Here you can also differ the stakeholder for each available Document Type (Sales Order, Purchase Invoice, Sales Invoice, Despatch Advice etc).d
Back at the overview for Error Handling you can chose only to state a stakeholder in the “Default” and not for the individual underlying Error Types, or you can indicate specific stakeholders for specific errors (other than the stakeholder stated as the Default one). You simply locate the row that contains the error in question and select the “Edit” option for that row.
...
Specify who the stakeholder is for that particular error code:
...
Customised error codes
(Demo in webinar Link for Developers chapter 6 - Error codes)
With the right user rights Link allows you to setup error codes that fits your organisation.
The setup of customised error codes is described in Link User Guide: /wiki/spaces/L300/pages/2478803743 .
How to set up error-handling
On the error handling page, you can get an overview of the different errors that can occur in your Link solution, divided into categories, as seen in the screenshot below.
...
Each error can have one or more stakeholders associated with it, which determines who will receive and handle the error. The different elements on the page will be explained in detail below.
Note: The data grid is set to group by Category as default when loaded. If your data grid is not grouped by category, press the 'Reset' button as explained in the Data Handling [1] section.
Data Handling [1]
...
These options allow you to perform actions on the entire data grid. They will be explained from left to right.
Column Chooser
This option makes it possible to customize which columns should be displayed in the data grid. Some columns are selected by default. When selecting it, you will be presented with a small window that contains all the columns that are not currently in use.
Initially (and after pressing refresh) all empty columns are automatically hidden to give a better overview of what is configured. Automatically hidden columns can be found in the column chooser if necessary. However, when stakeholders are added to columns that are hidden, the hidden columns are automatically shown again.
You can scroll while hovering your mouse over window box to see additional columns. To insert a new column you must drag it from the window to to the data grid. A blue line will appear when dragging, which means the column will be placed between the two columns. You can drag any column back to the window in the same manner. See the animation below for further reference.
...
Search
The search box will perform its search on the entire data grid and will exclude the rows that do not match the search dynamically. Use this to search for specific error messages or error ids. Press the 'x' next to the search term to reset the search.
Reset
Clicking this will reset the state of the grid to the default state. This means that all current sorting, grouping, filtering etc. will be reset. If you have placed or removed any columns via the column chooser, these will be reset as well.
Categories [2]
The errors are divided into categories. To expand a category, click the arrow to the left of the category name. All the errors in that category will be shown in the data grid. Click the arrow again to contract the category. Several categories can be expanded at the same time.
Notifications [3]
Each error can have one or more stakeholders, one for each document type. The colors represent who will be notified and whether the message is urgent. Let's take the example below.
...
One stakeholder has been added to each document type, but with different notification settings. The colors are as follows:
Blue: Notify stakeholder
Red: Urgent
Yellow: Notify sender
Green: Notify receiver
When the error occurs on a Purchase Invoice document, the stakeholder, sender and receiver will be notified and the mail will be marked as 'Urgent'. When the error occurs on a Purchase Order document, only the stakeholder (Supporters) will be notified and the mail will be marked as 'Urgent'.
Note that the default stakeholder will be used if no stakeholders have been specified for a document type.
Edit [4]
Click the 'Edit' button in the rightmost column to change the notifications settings for the error. A new window will open, allowing you to set what notifications should be sent for each document type. When you are done editing, press the 'Save' button in the lower right corner of the window, or press 'Cancel' to abort and return to the error handling page.
...
Category [1]
The category of the error will be shown here. This field is locked and not possible to edit.
Error [2]
The id and error message will be shown here. This field is locked and not possible to edit.
Stakeholder [3]
The stakeholder for a document type can be picked in the dropdown. The example above has 'Default' as the document type, which means it will be applied to all document types for this error, unless overridden. Select a stakeholder in the dropdown and tick the coloured checkboxes to set notification and urgency options. You may need to scroll to see additional document types.
Data Grid
As the data grid on the error handling page is set to be grouped by category by default, some standard data grid operations may not be available.
Sorting
To sort the categories, click the 'Category' group above the data grid. The categories are sorted in ascending order by default.
Pagination
A category may contain hundreds of errors when expanded. As such, the errors may be split unto several pages and the other categories will be hidden from view. At the bottom left of the data grid you have the option to choose the number of items that should be displayed on a single page. You can display from 15 up to 1000 items on a single page. By default 20 items are displayed.
You can navigate between pages in the bottom right of the data grid.
NOTE: This document is relevant for releases older than v. 3.0.9091.20157. If your Link system is running a newer release, please refer to this article instead.
After having set up your Stakeholders, you are now ready to configure how Link should handle document errors.
You will find the configuration page under “Settings” in the main menu.
...
Stakeholders in the error handling data grid
You are now presented with a list of predefined error categories presented in the Link data grid. if you haven’t done so already, remember to read the article Data grids.
Normal Link users only need to understand that there are several categories of error and under each category there are many different error codes (it’s even possible to create you own). Working with these in detail is for advanced users / developers - they can read more about the topic in the Link technical guide.
In this example, you can see the document type “Sales Order” appearing as a column in the grid. This means, that a configuration has been made in relation to this Stakeholder - all document types with stakeholder configurations will automatically appear in the data grid. Note that if no stakeholder configuration has been done for a document type, it will not appear in the data grid.
...
Too view or edit any stakeholder configuration, you need to open each category by clicking the arrow next to the category label.
...
In this example, the stakeholder “EDI support” has been assigned to all errors (they are assigned as Default) with the error code category “DataValidationErrors” - except for the error code SYE3G which for Sales orders will be handled by the “Developers” stakeholder.
Hopefully, you can see from this example that it’s possible to fine-tune who should act as Stakeholder in very specific scenarios - each combination of error categories / error codes and document types can have an assigned stakeholder.
When assigning your stakeholders to error codes and/or categories, it is a good idea to do this in collaboration with developers to avoid misunderstandings.
The columns “Error”, “Technical Description”, “Area” and “Component” are all non-editable fields configured on the error codes and error code categories.
The Error handling detail page
If you click Edit at the right side of a line you will see how an individual configuration is set up.
...
On this screen you can see the configuration options “Stakeholder”, “Notify stakeholder”, “Is urgent”, “Notify sender” and “Notify receiver” appearing for the Default level as well for each available document type. In this example we only have the document type “Sales Order” available, but if there were more configured there would also be configuration sections for those visible.
In order to set the stakeholder as active for the relevant section, you must check the box “Notify stakeholder”.
Note. The important concept to understand is that if there is a stakeholder configuration for at specific document type, this will take precedence over the Default configuration.
Urgency and notification of senders and receivers
We will now explain how the fields “Is urgent”, “Notify sender” and “Notify receiver” works.
Is urgent
If this checkbox is ticked, Link will send a notification to the e-mail address configured in the “Email urgent” field on the stakeholder. Often, Link customers choose to associate an SMS-gateway with this e-mail, the purpose being that urgent notifications are read as fast as possible.
Note that the red icon will appear in the data grid if this option is enabled.
Notify sender
If this checkbox is ticked, Link will send a notification to the e-mail address configured on the first technical contact person registered under the partner that sent the relevant document.
Note that the yellow icon will appear in the data grid if this option is selected.
Notify receiver
If this checkbox is ticked, Link will send a notification to the e-mail address configured on the first technical contact person registered under the partner that should receive the relevant document.
You can read more about setting up the contact persons on partners in this article: Contacts.
Note that the green icon will appear in the data grid if this option is enabled.