IDOC exchange monitoring

IDOC exchange monitoring

This monitor is dedicated to the monitoring of IDOC messages.
It will look for ERROR or WAITING status of messages received with a given period of time.
You can customize the monitoring by creating specific rules
depending on the client, the message type, the partner and the direction.

Configuration hints

Use the surveillance table to adjust the monitoring settings:
- Thresholds
- Severity
- Filters

Period:

The time period must be configured in a consistent way together with the schedule time of the monitor.
If the monitor is configured to run every 15 minutes, it is advised to set a period of 15 minutes too.
You can set longer periods if you want to catch the number of errors within a large time frame, for statistics purpose.
With a period of 10 minutes, when the monitor runs at 12:00, it will look for IDOC messages occurred between 11:50 and 12:00.

Aggregate:

This option allows to tune the volume of alarm that will be generated:
- If enabled, you will only get one alarm if the count of IDOC matching the filter is above threshold.
- If disabled, you will receive one alarm per IDOC, with details.

Multi severity threshold:

You can use the multi threshold syntax to define multiple threshold/severity settings per rule.

Exclusions:

You can define exclusion rules to quickly filter out results.

Configuration

Collect all states:
- If enabled, the monitor will collect IDOC message from any state instead of focsuing on WAITING/ERROR states
- To be used only if Send metadata is active. This allows to send all IDOC messages headers to an integration
Send metadata:
- If enabled, this parameter will send collected IDOC as metadata to the configured plugins/integrations
- It can usually be retrieved as logs or tabular data within the corresponding integrations
Send metrics
- If enabled, the monitor will send metrics (See metrics table below)
Type exclude list
- A coma separated list of IDOC types to exclude.
- Example:
  - MATMAS, DEBMAS
  - Will ignore IDOC errors with type MATMAS and DEBMAS

Surveillance table

Parameter	Description
Active	Use this field to activate or deactivate a line of configuration.
Client	A filter to match only IDOC messages for/from a given client
Message type	A filter to match only IDOC message of a given type
Partner	A filter to match only IDOC for/from a given receiving partner
Sending Partner	A filter to match only IDOC for a given sending partner
Status code	A filter to match only IDOC in error state with a particular status code
Direction	Defines the direction of the IDOC messages to look for
Status	Define the type of status to look for.
Time period (min)	Defines how far in the past the monitor will look for IDOC messages at each check.
Max error	The threshold for the maximum number of IDOC messages matching the filters and status settings.
Aggregate	If enabled, the monitor will count the number of IDOC matching the filter and send an alarm if it reaches the threshold. If not enable, it will send an alarm per IDOC.
Severity	The severity of the alarm.
Auto clear	If checked, the alarm will be cleared as soon as the alarm condition is not met anymore.
Alarm tag	This field allows to add custom text within the alarm message. %MSG% variable will contain the actual generated message and can be used such as: “my_prefix %MSG% my_suffix”. By default, tag will be used as prefix.
Exclusive	If checked, any IDOC matching this filter will not be processed by subsequent rules
Alarm	If checked, this line of surveillance will be used for alarm generation.
Report	If checked, this line of surveillance will be used for report generation.

Examples

Active	Client	Message type	Partner	Status code	Direction	Status	Time period (min)	Max error	Aggregate	Severity	Auto clear	Alarm tag	Alarm	Metric	Report
true	*	*	*	*	ANY	ERROR	15	1	TRUE	MAJOR	true		true	false	false

Effect : Sends a MAJOR alarm if an IDOC message with an ERROR status is found in the last 15 minutes

Examples

Active	Client	Message type	Partner	Status code	Direction	Status	Time period (min)	Max error	Aggregate	Severity	Auto clear	Alarm tag	Alarm	Metric	Report
true	800	*	*	*	INBOUND	WAITING	60	10	TRUE	WARNING	true		true	false	false

Effect : Sends a WARNING alarm if 10 or more IDOC messages with WAITING status from client 800 are found in the last 60 minutes.

Generated metrics

metricId	metricUnit	metricTarget	metricDescription
FAILED_IDOC_MESSAGES	IDOCS	[CLIENT][DIRECTION][TYPE][PARTNER][ERROR_CODE]	Sends the number of failed IDOCS matching the filter. Target field will be set according to how specific is the configuration
WAITING_IDOC_MESSAGES	IDOCS	[CLIENT][DIRECTION][TYPE][PARTNER][ERROR_CODE]	Sends the number of waiting IDOCS matching the filter. Target field will be set according to how specific is the configuration

Table of Contents

IDOC exchange monitoring

Configuration hints

Configuration

Surveillance table

Examples

Examples

Generated metrics