IDoc

IDocs (Intermediate Documents) are standard containers for exchanging data between applications. Between SAP applications they are transferred using the ALE (Application Link Enabling) layer which again uses either tRFC or File technology as the underlying technique.

An IDoc contains different types of information. It contains the application data to be exchanged (e.g. a sales orders) as well as technical data providing information from where to where the IDoc is supposed to be sent. Furthermore, the IDoc also contains status information that shows which processing step within the data exchange the IDoc is currently in. These statuses can indicate error situations or success situations. Some of them can be intermediate statuses that are indicating backlog situations.

For an end-to-end ALE monitoring it is necessary to monitor the various IDoc statuses in the outbound as well as the inbound direction.

Technical Prerequisites

To monitor IDocs the following prerequisites have to be met by the managed system:

  • Basis release ≥ 7.00 on all managed systems

Advanced Integration Monitoring Setup

Please, select...

To be able to monitor interfaces of an on-premise system you first have to add it to Interface & Cloud Monitoring and select the monitoring categories you want to monitor for the system. 

  1. Open the Advanced Integration Monitoring Application by clicking on the 'Integration & Cloud Monitoring' tile in transaction FRUN
  2. Click on the pinwheel in the upper right corner of the 'Integration & Cloud Monitoring' application
  3. In the configuration panel expand the 'Technical Systems' tray and click on the pen icon in the upper right corner. This will open the 'Integration and Cloud Monitoring - Systems' view. 
  4. If your system is not on the list yet, click the 'Add' button to add it. If it is on the list, click on the system ID of the system. 

In the next step, you see all monitoring categories which are available for the system, depending on the system type and the installed software components. Some recommended standard monitoring categories are preselected.

Select the monitoring categories in scope.

Monitoring Categories

The available monitoring categories are:

  • IDoc: IDoc sent to or from the ABAP system (Monitoring transaction WE05).

Please, select...

After selecting your monitoring categories you have to maintain filters to define what exactly you want to monitor. Some monitoring categories come with standard filters that usually just select all items of this monitoring category. Focused Run can handle this high amount of monitoring data, so you can stick to this standard filters. Or you can set up filters of your own. You can create more than one filter for a monitoring category.

Available Filter Options

For IDoc Monitoring you can collect all IDocs sent or received in the managed system. You can also use the following filter parameters, to restrict the data collection:

IDoc

  • Direction: Direction of the message flow from the perspective of the monitored system.
  • Partner Number of sender/receiver: Receiver Partner Number or Sender Partner Number
  • Partner Type of sender/receiver: Receiver Partner Type or Sender Partner Type
  • Partner Function of sender/receiver: Receiver Partner Function or Sender Partner Function
  • Message Type: Message type, e.g. ORDERS
  • Basic Type: IDoc type, e.g. ORDERS05
  • Message Code: Message variant of the IDoc
  • Message Function: Message function of the IDoc

To find the correct values for the IDocs you want to monitor, you can use transaction WE05 in the managed system to display the IDoc and the filter values.

Please, select...

The setup of the filters for the monitoring categories only makes sure that the data is collected, however, alerts are not created automatically. To create alerts and notifications you have to create an alert individually. If you didn't use specific filters in the setup before, but rather opted to collect all data, you have to create filters for the alerts.

  1. Click on the 'New Alert' button in the upper right corner of the alerts table. A new panel will appear below the table for you to enter the alert information
  2. Select the monitoring category
  3. Select the metric name. The available metrics depend on the monitoring category.
  4. Enter a name for the alert
  5. Enter a name for the filter

In the next sub-step, you have to maintain the filter. The filter values are the same as described above. For some metrics, you have to maintain metric parameters. Find details below in the overview of the available metrics.

In the last sub-step you have to activate the alert:

  1. Check the checkbox next to 'Active'
  2. You can adjust the calculation frequency and the severity
  3. Available threshold types depend on the metric selected. If the threshold type allows it you can adjust the threshold value which triggers the alert.
  4. Select the notification variant and the outbound connector variant from the drop-down list.

For single exceptions, the threshold type is always 'Already Rated'. This means depending on the calculation frequency the number of exceptions is checked and an alert is created if this number is bigger than 0. If you want to reduce the number of alert for these metrics, you could increase the value for the calculation frequency to increase the time between checks.

Available Metrics

For interfaces of type IDoc the following metrics are collected:

  • IDocs in status "Error" for longer than N minutes: Indicates new IDocs in the status group ERROR were collected during the collection interval
    Metric parameters: 
    • STATUS_GROUP (not changeable) = ERROR
    • OLDER_THAN_MINUTES = Only consider IDocs older than [minutes] 
  • Number of IDocs in status "Backlog" for longer than N minutes: The number of new IDocs in the status group INTERMEDIATE found during the collection interval
    Metric parameters:  
    • STATUS_GROUP (not changeable) = INTERMEDIATE
    • OLDER_THAN_MINUTES = Only consider IDocs older than [minutes]

Please, select...

After selecting your monitoring categories you have to maintain filters to define what exactly you want to monitor. Some monitoring categories come with standard filters that usually just select all items of this monitoring category. Focused Run can handle this high amount of monitoring data, so you can stick to this standard filters. Or you can set up filters of your own. You can create more than one filter for a monitoring category.

Available Filter Options

For IDoc Monitoring you can collect all IDocs sent or received in the managed system. You can also use the following filter parameters, to restrict the data collection:

IDoc

  • Direction: Direction of the message flow from the perspective of the monitored system.
  • Partner Number of sender/receiver: Receiver Partner Number or Sender Partner Number
  • Partner Type of sender/receiver: Receiver Partner Type or Sender Partner Type
  • Partner Function of sender/receiver: Receiver Partner Function or Sender Partner Function
  • Message Type: Message type, e.g. ORDERS
  • Basic Type: IDoc type, e.g. ORDERS05
  • Message Code: Message variant of the IDoc
  • Message Function: Message function of the IDoc

To find the correct values for the IDocs you want to monitor, you can use transaction WE05 in the managed system to display the IDoc and the filter values.

Please, select...

The setup of the filters for the monitoring categories only makes sure that the data is collected, however, alerts are not created automatically. To create alerts and notifications you have to create an alert individually. If you didn't use specific filters in the setup before, but rather opted to collect all data, you have to create filters for the alerts.

  1. Click on the 'New Alert' button in the upper right corner of the alerts table. A new panel will appear below the table for you to enter the alert information
  2. Select the monitoring category
  3. Select the metric name. The available metrics depend on the monitoring category.
  4. Enter a name for the alert
  5. Enter a name for the filter

In the next sub-step, you have to maintain the filter. The filter values are the same as described above. For some metrics, you have to maintain metric parameters. Find details below in the overview of the available metrics.

In the last sub-step you have to activate the alert:

  1. Check the checkbox next to 'Active'
  2. You can adjust the calculation frequency and the severity
  3. Available threshold types depend on the metric selected. If the threshold type allows it you can adjust the threshold value which triggers the alert.
  4. Select the notification variant and the outbound connector variant from the drop-down list.

For single exceptions, the threshold type is always 'Already Rated'. This means depending on the calculation frequency the number of exceptions is checked and an alert is created if this number is bigger than 0. If you want to reduce the number of alert for these metrics, you could increase the value for the calculation frequency to increase the time between checks.

Available Metrics

For interfaces of type IDoc the following metrics are collected:

  • IDocs in status "Error" for longer than N minutes
    Adjustable metric parameters:  
    • OLDER_THAN_MINUTES = Enter the number of minutes after which an IDoc in error state should be considered in the count 
  • Number of IDocs in status "Backlog" for longer than N minutes
    Adjustable metric parameters:  
    • OLDER_THAN_MINUTES = Enter the number of minutes after which an IDoc in an intermediate state should be considered in the count

Further Information

Which statuses fall into status group ERROR and status group INTERMEDIATE is based on the IDoc customizing tables STACUST and STALIGHT in the managed system. The customizing table STACUST which determines the qualification for an IDoc status is maintained with transaction WE47.