Show TOC

Configuring the User-Defined Message SearchLocate this document in the navigation structure

Use

The user-defined message search enables you to search for asynchronous messages using the following attributes:

  • Attributes of the XML main payload

  • Adapter-specific message attributes

More information: Monitor for Processed XML Messages

Procedure

To configure the user-defined message search, perform the following steps:

  • Define filters to select the messages you want to search for later on.

  • Define extractors to extract from the selected messages those message attributes that you want to use for the message search later on.

  • For each filter, define a namespace prefix (optional) that you want to use for the extractors of this filter.

Defining Filters

You can create (add), change, or delete filters for selecting messages. In change mode, you can activate or deactivate a filter.

Note

You can only activate a filter if you have already defined an extractor for this filter (see below). When you double-click a filter, all extractors that are defined for this filter are listed.

To create a filter, proceed as follows:

  1. Execute the SXMS_LMS_CONF transaction.

  2. In the filter list, choose Add and specify the required selection criteria.

    Input help with values from the local Integration Directory cache is available to help you specify your selection criteria.

    You can use an asterisk (*) for manual specification. For interface names and namespaces, however, this is only true if you want to extract adapter-specific message attributes from your messages.

    Note

    When entering your filter criteria, take into account that message indexing happens twice: once after they have been received and once before they are sent.

  3. Choose Continue. The new filter appears in the filter list.

Defining Extractors

You always define extractors for a given filter. You can create (add), change, or delete extractors.

To create an extractor, proceed as follows:

  1. In the filter list, double-click the filter for which you want to define an extractor.

  2. In the Extractors for each filter list, choose Add and specify the following:

    • Extractor name

      Enter a meaningful name, because it is used as search term for the message search in monitoring

    • Description

      Enter a short description. It is used as input help in monitoring.

    • Type

      You can choose between two types:

      • XPath

        This type of extractor uses an XPath expression to search for attributes in the main payload of a message

      • Dynamic Header

        This type of extractor searches for adapter-specific message attributes. These are identified by interface name and namespace.

    • Method

      You can choose between two methods:

      • Extract During Message Processing

        Select this method if you want the attributes to be extracted from the selected messages while these messages are processed.

      • Extract with External Job

        Select this method if you want to extract attributes from messages that were already processed, or if you want to change the extraction of attributes from messages, from which attributes were already extracted.

        For this method you need to set up and use the job SXMS_EXTRACT_MESSAGES.

  3. Choose Continue.

    The new extractor appears in the list of extractors for the selected filter.

    Note

    The extractor is only active if you have selected at least one of the two available methods.

Defining Namespace Prefixes

You can use a namespace prefix instead of a namespace in XPath expressions. You always define a namespace prefix for a given filter. You can then use it for all extractors of type XPath for this filter. You can create (add), change, or delete namespace prefixes.

To create a namespace prefix, proceed as follows:

  1. In the filter list, select the filter for which you want to define the namespace prefix.

  2. In the Namespace prefixes for each filter list, choose Add and specify the following:

    • Prefix Enter your prefix.

    • Namespace Enter the namespace for which you want to use this prefix.

  3. Choose Continue. The new namespace prefix appears in the list of namespace prefixes for the selected filter.

Testing Extractors

On the Integration Engine, you can test if an extractor extracts attributes from a particular message as intended.

  1. Choose Test Extractor .

  2. Enter the ID of the relevant message.

  3. Choose Continue .

    You obtain an extractor log that contains the values found.