SAP IDoc Monitor

Monitoring of inbound and outbound IDocs. Checks if there are IDocs in the queue that were not executed. You can filter by specific error states, sender partner name of inbound IDocs or receiver partner name of outbound IDocs.

General

Executable	SAP_IDoc_Monitor.exe
Connection method	RFC
Ports	33$$ 48$$ (SNC) ($$ = Instance number)

Default parameters

Parameter name	Possible values	Default	Description
Host	<ip> | <hostname>	empty	Hostname or IP of the target system. If you use a virtual hostname on your SAP servers, please use also the virtual host to connect.
SAPSID	string (3) | XXX	empty	SID of the SAP system
SAPInstance	number (2) | 00 - 99	empty	Instance number of the SAP system
SAPClient	number (3) | 000 - 999	empty	SAP Client (CLNT/MANDT)
SAPUsername	string	empty	SAP user
SAPPassword	string	empty	Password of the SAP user

Sensor-specific parameters

Parameter name	Possible values	Default	Description
SensorID	0 | 1 | <sensorID>	1	ID of the sensor in the PRTG If ID 0 is passed, IDocs are checked from the beginning of the month If ID 1 is passed, IDocs will be checked as of today If the ID of the PRTG sensor is maintained, IDocs will be checked from the last sensor run This parameter can be set in the PRTG setting of the sensor like this: PRTG will automatically replace %sensorid by the sensor's ID.
Types	<type1>,<type2>,<type3>,...	*	Only consider certain IDocs types. Comma separated input possible. is treated as a wildcard (only allowed at the beginning or end of a term) Example: USERCLONE, INVO*,*MAS
ErrorStates	number | 00 - 99	02, 04, 05, 07, 11, 20, 21, 26, 27, 29, 31, 34, 36, 37, 40, 51, 52, 54, 56, 57, 60, 63, 65	Error states of inbound and outbound IDocs to be checked (comma separated)
InboundSenderPartner	<partner1>,<partner2>,<partner3>,...	*	Sender partner name of inbound IDocs (comma separated)
OutboundReceiverPartner	<partner1>,<partner2>,<partner3>,...	*	Receiver partner name of outbound IDocs (comma separated)

Channels

Channel name	Description	Lookup file
IDOCs last period	Number of IDocs that have been processed (does not depend on <InboundSenderPartner>, <OutboundReceiverPartner> or <ErrorStates>)
IDOCs Errors	Number of IDocs with errors (does not depend on <InboundSenderPartner>, <OutboundReceiverPartner> or <ErrorStates>)
Inbound - IDOC Errors	Number of inbound IDocs with errors since last run (depending on <InboundSenderPartner>)
Inbound - IDOC last period	Number of inbound IDocs that have been processed since the last run (depending on <InboundSenderPartner>)
Outbound - IDOC Errors	Number of inbound IDocs with errors since last run (depending on <OutboundReceiverPartner>)
Outbound - IDOC last period	Number of outbound IDocs with errors since last run (depending on <OutboundReceiverPartner>)

Important notes

info

The types of IDocs with errors will be printed in the sensor text.

warning

Please check the channel limits in PRTG if they fit for your alerting.

Changelog

Version	Changes
2022.08	Improved filters to avoid OPTION_NOT_VALID exception with new SAP RFC_READ_TABLE function module
2020.09	Added new channels "Inbound - IDOC Errors", "Inbound - IDOC last period", "Outbound - IDOC Errors" and "Outbound - IDOC last period" Added new sensor specific parameters "ErrorStates", "InboundSenderPartner" and "OutboundReceiverPartner" Adapted the result text to display the IDoc type with the exact number of IDocs with errors (e.g. 6 x <IDoc type>) Using the update time instead of creation time of IDocs when when executing the query
1.4.0.1	Rebuild for new signature of AddChannel method
1.4.0.0	Build for installer 1.4.0
1.3.6.1	Added threshold values
1.3.6.0	First stable release