The user-defined message search enables you to search for synchronous/asynchronous messages using the following attributes:
- Attributes of the XML main payload
- Adapter-specific message attributes
You use this transaction to maintain filters and search criteria for extracting data from the dynamic header or the payload of messages.
Prerequisites
To execute all functions of this report, your user must be assigned one of the following authorizations:
- Object: S_XMB_AUTH
- SXMBAREA: MESSAGE
- ACTVT: 02
This authorization is included in the roles SAP_XI_ADMINISTRATOR_ABAP and SAP_XI_MONITOR_ABAP as standard.
If the user only has the following authorization, the report starts with restricted functionality. In this mode, the user cannot make any changes to filters, search criteria (extractors), or namespace prefixes:
- Object: S_XMB_AUTH
- SXMBAREA: MESSAGE
- ACTVT: 03
This authorization is included in the roles SAP_XI_ADMINISTRATOR_ABAP and SAP_XI_MONITOR_ABAP as standard.
Procedure
To configure the user interface for the user-defined message search, proceed as follows:
- Define filters for selecting the messages that you want to search for later on.
- Define extractors for extracting from the selected messages those message attributes that you want to use later on for the message search.
- (Optional) Define a namespace prefix for each filter to use for the extractors.
Execution
The configuration UI comprises the following areas: Filter List, Search Criteria for Selected Filter, and Namespace Prefixes for Selected Filter.
Filter List Block
In this area, you define which messages you want to extract. To do this, you define a filter that describes the set of messages you want to extract.
Note: You can only activate a filter if you have already defined at least one active extractor for it. If you double-click a filter, all extractors that are defined for it are listed (see block Search Criteria for Selected Filter).
Search Criteria for Selected Filter Block
In this area, you define which data you want to extract from the messages. First, select a filter from the filter list by double-clicking it. Then, create a search criteria (extractor) for this filter.
You use the type to define whether the data should be taken from the dynamic header or the payload:
- XPath:
- This extractor type uses an XPath expression to search for attributes in the main payload of a message.
- Dynamic Header:
- This extractor type searches for adapter-specific message attributes. These attributes are identified using the interface name and namespace.
The extraction method specifies when the evaluation should take place: during message processing or later, using a background job:
- Extract During Message Processing:
- The evaluation takes place at the start and end of message processing, as long as the message is selected by the filter. This method is only available for asynchronous messages.
- Extract Using External Job:
- Evaluation takes place later, using a background job. You can use this method to extract synchronous and asynchronous messages.
Note: Synchronous messages must be persisted if they are to be extracted. To do this, use the parameter LOGGING_SYNC to activate logging for synchronous messages.
Note: The extractor is only active if you have selected at least one of the two available methods.
Namespace Prefix for Selected Filter Block
In XPath expressions, you can use a namespace prefix instead of a namespace. You must always define a namespace prefix for a filter. You can then use it for all extractors of type XPath for this filter.
Test Search Criteria
To test whether an extractor extracts the attributes from a particular message as expected, choose Test Search Criteria and enter the ID of the respective message. You get the extractor log with the found values.
Values that are extracted by the test functions are not saved in the database. Therefore, these values cannot be used as criteria for the user-defined search in the PI monitor (transaction SXI_MONITOR).
Distribute Filter Settings
To reduce administrative effort, you can copy filter settings to other PI systems by choosing Distribute Filter Settings.
Extraction Using Background Job
If you selected extraction using a background job when you defined a search criterion (extractor), the report SXMS_EXTRACT_MESSAGES must be scheduled as a job in the same client.
Reorganization of Extracted Data
The data extracted from a message for the user-defined search is integrated into the lifecycle of the message. This means that if the message is deleted, all data extracted from this message is also deleted automatically. No further action is required.
