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.

In this section:

Contents:

Default KPIs delivered with this collector

The following default KPIs are delivered with this collector:

KPI name	Description	Unit	Detail table
IDOC_INBOUND_C	Total count of inbound IDocs for the last snapshot	Count	No
IDOC_IN_ERRORS	Number of errors in inbound IDocs processing	Count	Yes
IDOC_I_PROC_AVG	Average time of successful inbound IDoc processing (50-53)	Second	No
IDOC_OUTBOUND_C	Total count of outbound IDocs for the last snapshot	Count	No
IDOC_OUT_ERRORS	Number of errors in outbound IDocs processing	Count	Yes
IDOC_O_PROC_AVG	Average time of successful outbound IDoc processing (01-30)	Second	No
IDOC_O_TRANS_AVG	Average time of successful transmission (03->12)	Second	No

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-2305) 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 name	Column name	Description
KPI	KPI name	Name of the KPI that rule applies to
KPI_RULE_NUMBER	KPI Rule Number	Sequence of rules (Filled in, if a KPI includes several rules)
UNIT	Unit	Type 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_TIME	Processing time	Processing time threshold (Filtering field) IDocs below this threshold value will be ignored. When the value is not defined, this field is ignored.
STATUS	Status	Current status code of an IDoc checked against the IDoc status record with the newest date and time (Filtering field)
DIRECT	Direction	IDoc message direction: (Filtering field) '2': Select only inbound IDocs '1': Select only outbound IDocs not defined: Select all IDocs
DOCTYP	IDoc Type	IDoc type (legacy) (Filtering field)
MESTYP	Message Type	IDoc message type (Filtering field)
RCVPOR	Receiver Port	Receiver port from IDoc control record (Filtering field)
RCVPRT	Receiver Partn. Type	Partner type of receiver from IDoc control record (Filtering field)
RCVPRN	Receiver Partner No.	Partner number of the receiver from IDoc control record (Filtering field)
SNDPOR	Sender Port	Sender port from IDoc control record (Filtering field)
SNDPRT	Sender partner type	Partner type of sender from IDoc control record (Filtering field)
SNDPRN	Sender partner no.	Partner number of the sender from IDoc control record (Filtering field)
ADD_TO_DETAIL	Add to details	When checked, IDoc records selected by this rule are added into the Detail table.
FROM_LASTRUN	Snapshot 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_BY	Changed by	Last changed by user [automatically filled].
CHANGED_AT	Changed at	Last changed date [automatically filled].

Parameters

The 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

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.

The Detail table contains the following fields:

Technical name	Description
TIMESTAMP	When the records are saved into the Detail table
SID	System ID
KPI	KPI name
DOCNUM	IDoc number
MANDT	Client ID
CREDAT	IDoc creation date
CRETIM	IDoc creation time
LOGDAT	Status creation date
LOGTIM	Status creation time
DIRECT	Direction for IDoc
STATUS	Status of IDoc
STATXT	Status text
DOCTYP	IDoc type
MESTYP	IDoc Message type
MESCOD	Logical message variant
ARCKEY	EDI archive key
PROCESSING_TIME	IDoc processing time
RCVPOR	Receiver port
RCVPRT	Partner type of receiver
RCVPRN	Partner number of receiver
SNDPOR	Sender port
SNDPRT	Partner type of sender
SNDPRN	Partner number of the sender
CUSVAL1	Custom value 1
CUSVAL2	Custom value 2
CUSVAL3	Custom value 3
CUSVAL4	Custom value 4
CUSVAL5	Custom value 5
CUSVAL6	Custom value 6
CUSLVAL1	Custom value (long) 1
CUSLVAL2	Custom value (long) 2
CUSNUM1	Custom number 1
CUSNUM2	Custom 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-2305) Enhance IDoc Detail Table Records.

Browser not supported