Ansicht
Dokumentation

SXMB_GET_MESSAGE_LIST - Returns list of messages according to selction criteria

PERFORM Short Reference   Vendor Master (General Section)  
This documentation is copyright by SAP AG.

Functionality

This function module provides comprehensive search features for messages on database of integration engines. Search parameters are supplied by import structure IM_FILTER.

Almost any of the filter attributes corresponds to select fields provided by transaction SXI_MONITOR. To learn more about how particular field works, have a look at the selection screen of this transaction.

Import structure IM_FILTER:

As many of the fields in the filter structures are explained with the short texts, only some of the most important or some of the most remarkable are considered here explicitly:

FROM_TIME, TO_TIME: Determine time interval within which matching messages were executed last time. The time stamp values are expected to be UTC based.

STATUS: Don't use this field as it is here only for compatibility reasons and its value will be completely ignored. Use the following field for the purpose of limiting particular message states instead:

MSGSTATE_TAB: List of message state values to limit the search for. To retrieve the value list or detailed information about all message states, call RFC module SXMB_GET_STATUS_ATTRIBUTES.

ERRLABELID: Determine particular Status Detail value to search for. The value domain for this parameter can be obtained by RFC module SXMB_GET_ERRLABEL_ATTR.

EXTR_DATA, USE_OR: These two parameters belong together. EXTR_DATA contains the attribute name and value combination of user-defined search criteria the search should be limited on. By default, all entries in EXTR_DATA are combined by "and", and setting USE_OR to value 'X' will force entries in EXTR_DATE to be combined "or" wise.

EX_MESSAGE_DATA_LIST contains a comprehensive set of attributes for each message, almost those ones which can also be used as filter criteria.

EX_MESSAGE_LMS_LIST is a sort of extension to the result list. It has exactly the same number of entries in the same order according to MSGGUID and PID as EX_MESSAGE_DATA_LIST. This is to easily be able to bring entries of both lists together by relating lines with the same table index.

This extension table to result list contains the values for user-defined search attributes. If this information is not of interest, this parameter should be not supplied as data is only retrieved in case the parameter is provided. This may slightly increase performance in such case.

EX_FIRST_TS contains the earliest EXE timestamp found in the message result list. This is especially useful when result list length is limited by IM_MESSAGE_COUNT. Using this timestamp value it is possible to proceed the search by grabbing the next recent messages, followed by invocation of this function module.

Example

Notes

Please consider that this function will return an empty result set in case it is invoked with empty import parameters. Following parameters are to be applied obligatory:

Even if checked as optional, the IM_MESSAGE_COUNT parameter has to be set to limit selection to a maximum number of messages to be returned. Not applying this parameter or setting it to 0 will force an empty result list, while some may expect this will mean unlimited number of matching messages to be returned.

IM_FILTER-FROM_TIME as well as IM_FILTER-TO_TIME must define a proper time interval. It is not possible especially to leave one or both initial.

Further information

Parameters

EX_FIRST_TS
EX_MESSAGE_DATA_LIST
EX_MESSAGE_LMS_LIST
EX_RESULT
IM_FILTER
IM_MESSAGE_COUNT

Exceptions

INTERNAL_ERROR
NOT_AUTHORIZED
NO_MESSAGE
TOO_MANY_MESSAGES

Function Group

SXMB_MONI

rdisp/max_wprun_time - Maximum work process run time   PERFORM Short Reference  
This documentation is copyright by SAP AG.

Length: 3933 Date: 20240523 Time: 090330     sap01-206 ( 80 ms )