Show TOC

Configuring User-Defined Search in MessagesLocate this document in the navigation structure

Use

User-defined search enables you to search for asynchronous Web service operations using attributes from the XML payload.

For each Web service operation, you can configure what content of the payload is indexed. You can also configure whether the payload is indexed at runtime or through a batch job at a later point in time. This batch job can either be scheduled or you can run it manually.

Direct Extraction (Default)

In the default setting, messages are indexed directly at runtime. In this case, the message is indexed while it is in memory, which puts less strain on your system's resources.

Asynchronous Extraction

In asynchronous extraction, the indexing is moved into a separate process and is thus not part of the response time. Asynchronous extraction makes sense in UI-based scenarios, where the response time is critical and large messages are processed. Note the following three disadvantages of asynchronous extraction:

  • It costs more system resources compared to direct extraction

  • The user-defined search in the message monitor does not find messages until after the next indexing job has run.

  • You might need to monitor the result of the indexing job in transaction SM37.

To use asynchronous extraction, you have to use the program SRT_UDS_AUTO_INDEX or SRT_UDS_INDEX. For more information, see Asynchronous Message Indexing for User-Defined Search.

Prerequisites

You are assigned a role that includes authorization object S_SRT_UDS. Note that there are four activities in this authorization object.

The Web service whose payload you configure is available in your ABAP system.

Procedure

To configure the user-defined message search, specify the attributes that you want to use for the message search in the message monitor.

  1. In SOA Manager (transaction SOAMANAGER), go to the Monitoring tab and choose User-Defined Search.

    Alternatively, use the SUDSCONFIG transaction to jump directly to the User-Defined Search: Configuration page.

  2. Use the search to display configurations.

    You can specify the interface, the interface namespace, and/or the operation as search criteria.

    In the search results, select a configuration and choose one of the following:

    • The Display icon to display a configuration.

    • The Edit icon to edit a configuration.

    • The Delete icon to delete a configuration.

    You can also activate and deactivate one or more configurations that you select in the table.

  3. To create a new configuration, choose Create and search for the Web service operation you want to configure. Note that only asynchronous Web services can be configured as only asynchronous Web services are persisted.

  4. The user-defined search configuration is displayed. You can switch between Display and Edit mode.

  5. To add a field to the configuration, drag and drop it from the fields list to the Search Parameters table. You can either drag a field into a new row or add it to an existing parameter in the table. Alternatively, you can right-click a field and choose the appropriate action from the context menu.

    If you add a field to an existing search parameter, this parameter's search name is taken over. If you add a field in a new row, this field's name is used as the search name. You can edit the search name later.

    Note

    Not all fields in the field list to the left can be configured for user-defined search. A field that is not valid for configuration cannot be dragged and dropped to the Search Parameters table, and in its context menu, the Add option is grayed out.

    Note

    If you select a search parameter in the configuration table, the corresponding field is highlighted in the Fields panel to the left. This might be useful in complex configurations of large payloads.

  6. Specify the extraction type. You can choose between direct extraction at message runtime or extract search results in a deferred batchjob.

  7. (Optional) Check the consistency of the configuration by choosing Check.

    A configuration is consistent if the XML paths of all search parameters are in the interface of the design time object.

  8. Set the status of the configuration to Active.

    Only active configurations result in the indexing of the message payloads.

Result

You have configured user-defined search for a message payload. You can simulate the configuration from here. For more information, see Simulating Indexing Using a Configuration of User-Defined Search.

Your user-defined searches are available in the Web Service Message Monitor (on the User-Defined Selection tab). See Selection Criteria in the Message Monitor.

More Information