(DI-2205) Collector for IDocs

The technical name of the Collector for monitoring of IDocs is /DVD/MON_IDOC_CL_COL_EDIDC.

The default KPIs created through this collector display statistics about IDocs. IDoc records from Control (EDIDC) and Status (EDIDS) tables are evaluated to provide information, such as the total number of processed IDocs and error IDocs, information about the average IDoc processing time, the age of the oldest processed IDoc in an evaluated period, etc.

The default KPIs for the number of erroneous IDocs have assigned a Detail table that contains further details, for example about the message direction, message type, status code, error message, etc.

Contents:

Default KPIs delivered with this collector

The following default KPIs are delivered with this collector:

KPI nameDescriptionUnitDetail table

IDOC_INBOUND_C

Total count of inbound IDocs for the last snapshot

Count

No
IDOC_IN_ERRORSNumber of errors in inbound IDocs processingCount
Yes
IDOC_I_PROC_AVGAverage time of successful inbound IDoc processing (50-53)SecondNo
IDOC_OUTBOUND_CTotal count of outbound IDocs for the last snapshotCountNo
IDOC_OUT_ERRORSNumber of errors in outbound IDocs processingCountYes
IDOC_O_PROC_AVGAverage time of successful outbound IDoc processing (01-30)SecondNo
IDOC_O_TRANS_AVGAverage time of successful transmission (03->12)SecondNo

Note: All delivered IDoc KPIs have the prefix IDOC_*

Custom KPIs

The Collector for monitoring of IDocs enables you to create custom KPIs based on this collector. For more information on how to create a custom KPI, see the chapter (DI-2205) Create a KPI through the Collectors with a Custom KPI.

You can find an example of how to create a custom KPI, which is based on this collector in the chapter Example: Number of Errors in Inbound IDocs of the Message Type – Orders.

Custom KPIs based on this collector can provide more focused statistics about IDocs. For example, you may create a KPI which displays:

  • Error rate of a specific IDoc message type – by copying the Input table records of the KPIs IDOC_IN_ERRORS and IDOC_OUT_ERRORS KPIs, using them for your custom KPI and narrowing down the scope by specifying the message type MESTYP field
  • Number of IDocs from a specific sender or receiver
  • Non-error IDocs with detail records – when creating a custom KPI, we recommend specifying at least IDoc message types or setting up other restrictions in the Input table. Without these restrictions, the Detail table of this custom KPI may contain all the IDoc records, which can cause performance issues.

Input table

The IDoc collector uses the Input table /DVD/MON_IDOC_I1.

The rules in the Input table define the selection of IDoc control and status records and also how the KPI value is calculated with the following fields:

Technical nameColumn name Description
KPIKPI nameName of the KPI that rule applies to
KPI_RULE_NUMBERKPI Rule Number
Sequence of rules (Filled in, if a KPI includes several rules)
UNITUnitType of the value (count, average, age) KPI value is calculated as follows:
  • Count: number of selected IDoc records
  • Average: sum of processing times of selected IDoc records divided by the number of selected IDoc records
  • Age: maximum processing time in one of the selected IDoc records

Number of selected IDoc records = records that satisfy this rule during an evaluation period

PROCESSING_TIMEProcessing time

Processing time threshold (Filtering field)

IDocs below this threshold value will be ignored. When the value is not defined, this field is ignored.

STATUSStatusCurrent status code of an IDoc checked against the IDoc status record with the newest date and time (Filtering field)
DIRECTDirection

IDoc message direction: (Filtering field)

  • '2': Select only inbound IDocs
  • '1': Select only outbound IDocs
  • not defined: Select all IDocs
DOCTYPIDoc Type

IDoc type (legacy)

(Filtering field)

MESTYPMessage TypeIDoc message type (Filtering field)
RCVPORReceiver PortReceiver port from IDoc control record (Filtering field)
RCVPRTReceiver Partn. TypePartner type of receiver from IDoc control record (Filtering field)
RCVPRNReceiver Partner No.
Partner number of the receiver from IDoc control record (Filtering field)
SNDPORSender PortSender port from IDoc control record (Filtering field)
SNDPRTSender partner typePartner type of sender from IDoc control record (Filtering field)
SNDPRNSender partner no.
Partner number of the sender from IDoc control record (Filtering field)
ADD_TO_DETAILAdd to detailsWhen checked, IDoc records selected by this rule are added into the Detail table.
FROM_LASTRUNSnapshot from the last run

When checked, the evaluation period is between the last collector execution and the current collector execution.

When cleared, the start of the evaluation period is calculated using the parameter IDOC_MAX_SNAPSHOT_TIME. When this parameter is not defined, the default value is 24 hours.

CHANGED_BYChanged byLast changed by user [automatically filled].
CHANGED_ATChanged atLast changed date [automatically filled]. 


Parameters

Following parameters are used for this collector:

Parameter name

Description

COLLECT_FROM_ALL_CLIENTS


Should the collector select IDOC records from all clients? 

You might turn on the selection from all clients by setting this value to 'X'.

Default value: empty (select records only from the client-defined in the System definition)

IDOC_MAX_SNAPSHOT_TIME

Maximum snapshot time 

The length of an evaluation period (in minutes)

The default value in minutes: 1440

Detail table

The collector provides a detailed output in a Detail table for KPIs, which have a marked Add to detail in the Input table of the collector /DVD/MON_IDOC_CL_COL_EDIDC.
The name of the Detail table is IDocs details - /DVD/MON_IDOC_D1. It contains placeholder fields that can be populated using custom enhancement spot implementation. See the following section 725484128.

The Detail table contains the following fields:

Technical nameDescription
TIMESTAMPWhen the records are saved into the Detail table
SIDSystem ID
KPIKPI name
DOCNUMIDoc number
MANDTClient ID  
CREDATIDoc creation date
CRETIMIDoc creation time
LOGDATStatus creation date
LOGTIMStatus creation time
DIRECTDirection for IDoc
STATUSStatus of IDoc
STATXTStatus text
DOCTYPIDoc type
MESTYPIDoc Message type
MESCODLogical message variant
ARCKEYEDI archive key
PROCESSING_TIMEIDoc processing time
RCVPORReceiver port
RCVPRTPartner type of receiver
RCVPRNPartner number of receiver
SNDPORSender port 
SNDPRTPartner type of sender
SNDPRNPartner number of the sender
CUSVAL1Custom value 1
CUSVAL2Custom value 2
CUSVAL3Custom value 3
CUSVAL4Custom value 4
CUSVAL5Custom value 5
CUSVAL6Custom value 6
CUSLVAL1Custom value (long) 1
CUSLVAL2Custom value (long) 2
CUSNUM1Custom number 1
CUSNUM2Custom number 2

Enhancement spots

The collector contains the enhancement spot (BAdI) /DVD/MON_IDOC_BADI_DETAIL, which can be used to populate placeholder fields in the Detail table /DVD/MON_IDOC_D1. More information on how to create a custom implementation for this BAdI can be found in the chapter (DI-2205) Enhance IDoc Detail Table Records.