Introducing the SXI_MONITOR Generic Search Framework
The transaction SXI_MONITOR is used to monitor XML-Messages. This transaction enables you to search for XML-Messages, and filter them based on criteria like date, time, message ID, sender-, and receiver information etc. However, it is so far missing the functionality to filter the messages based on their content easily (transaction SXI_MONITOR also provides the possibility to search for content values, but that is more complex and can’t be run in background).
Therefore, the SXI Monitor Generic Search Framework (GSF) was developed. It introduces a new modular way to filter the messages based on the information extracted from their corresponding XML data. The goal of this development is to create an easy and customizable way to filter XML-Messages based on their content.
Details on the technical background can be found in the article Extension and enhancement of the SXI_MONITOR Generic Search Framework.
The new functionality is available by transaction code: SXI_MONITOR_GSF
Figure 1 shows a screenshot of the User Interface. So far, the user interface consists of two major sections. The standard selection criteria, which is not customizable, and the enhanced selection criteria, which is customizable using the GSF. The customization is explained below.
The standard selection criteria are used to pre-select messages as shown in Figure 1 (the uppermost box). The section containing the enhanced selection criteria is used to browse the content of the XML-message. The two dropdown menus “Search Object”, and “Selection Parameter” are used to group the technical names into different categories. The “Search Object” defines herby the generic term (e.g. Business Partner, Customer, Vendor etc.). The “Selection parameter” defines the subcategory (e.g. ID, Name etc.). Every Selection Parameter corresponds to an unlimited number of technical names. The grouping of the technical names is further explained in the enhanced technical description of Transaction SXI_MONITOR_GSF.
The pushbutton “Service Selection” provides the user with a popup (Figure 2) on which they can select the webservices they want to search for. By default, all webservices are selected. It is mandatory to select at least one webservice.
In the field “Value(s)”, enter the values you want to search for, e.g. different Business Partner IDs. After all fields are filled, the search can be started either by pressing F8, by clicking the button “Execute” in the lower right corner, or by choosing “More” -> “Program” -> “Execute”. The search starts in the foreground. The screen is locked until the program is done. An example of a result list is shown in Figure 3
The performance can be low due to a high number of messages that need to be extracted and analyzed. For that reason, foreground processing might not be useful. To offer more utility, background processing is available in the SXI Monitor Generic Search Framework. By choosing “More” -> “Program” -> “Execute in Background”, the search gets submitted as a job. You can display the running Job e.g. using transaction SM37 or via “More” -> “System” -> “Own Jobs”. After the job has finished, the message IDs found are displayed in the print job log as shown in Figure 4.
The message IDs can be easily copied and transported for further analysis to transaction SXI_MONITOR.
Delivery and initial usage hints
The new transaction is available via the following SAP notes:
- 2971973 – SRT_MONI_GSF Creation of package
- 3035719 – Generic Search Framework for SXI_MONITOR – Interface Note
- 3035724 – Generic Search Framework for SXI_MONITOR_GSF – Application Note
The SAP notes have to be applied in the given order.
Per default the new functionality is delivered for mainly Business Partner Messages searching the name, number of the Business Partner or the number of the customer / supplier.
The search itself for the Business Partner does support wildcard search – the standard SAP search parameters are provided.
As this is a very new functionality which hopefully enables easier access to data exchange via XML-Messages, a follow up Blog post will be provided to explain the technical background in more detail and also will provide a step-by-step description of the very easy to use enhancement concept.
In case an error occurs, you would need to raise an incident on application component LO-MD-BP-WS.
We have taken all measures possible to make this post as accurate as possible, but things sometimes fall through the cracks. In case you find any errors or inconsistencies please let us know.
The above given dates and times might change without notice and/or reflection in this blog. For latest accurate dates and times, please check out the referenced, and non-referenced information available from SAP
Thanks for your detailed blog.
What is not clear for me if it supports both inbound and outbound standard Business Partner messages or only outbound?
thank you for your question. At the moment only outbound messages is supported, but an extension for inbound messages is being planned.
Great, thanks for your clarification.
See the two new SAP notes 3090934 and 3091114 for inbound scenario is supported now as well
Hi Felix, Muhammed and Uwe,
Could you please shed some light on "GSF Development and Extension Guide"?
Best regards Michael