How-to enrich XI monitor’s output

I’ll try to give an answer here to a question which users tend to ask:

“Wouldn’t it be possible to display directly in the XI message monitor an additional field containing … whatever.“.

Here whatever could mean an idoc number, an order/delivery number, the message size, a more understandable error description, a dynamic configuration attribute and so on.

I’ll show how to insert an additional field to the output of the SXI_MONITOR transaction, containing the name of the file that originated the message, or, if possible, which the message is going to create (this of course will work in file scenarios only); minor changes can let you add other dynamic configuration values or other goodies, like an idoc number, to your enriched monitor.

We are basically going to do 3 things:

1. Create an ABAP Function Module that, given an XI message, returns an attribute (of our choice) from the dynamic configuration of the message;
2. Copy and extend the standard structure used to display the output of SXI_MONITOR;
3. Copy and edit the standard programs responsible for the output.

Let’s proceed:

1. This Function Module is quite involved: we have to get the XI message and extract the dynamic configuration’s data from it. Then we have to take the file name. We’ve got better chances to find the filename in the last version of the message, so we’ll consider only that one¹. The result will be a Function Module taking a message GUID, a namespace and an attribute name as input parameters, and returning the dynamic configuration value for that combination of namespace/attribute of the message identified by the message GUID.

Here is the code of the FM, name it whatever you like, remember that you can create a function module using transaction se37, but first you have to create a package: I suggest to follow Alessandro Guarneri‘s weblog on The specified item was not found. for this part, which I won’t repeat here.

FUNCTION Z_ITBC_GET_MSG_REF.*”———————————————————————-*”*”Local Interface:*”  IMPORTING*”     VALUE(MSGID) TYPE  MPG_GUID*”     VALUE(NAMESPACE) TYPE  STRING OPTIONAL*”     VALUE(ATTR) TYPE  STRING OPTIONAL*”  EXPORTING*”     VALUE(VALUE) TYPE  SXMS_DYN_CONF_VALUE*”———————————————————————-  DATA: li_ifmsg TYPE REF TO if_xms_message,        li_msg TYPE REF TO if_xms_message_xmb,        li_pay TYPE REF TO if_xms_payload,        li_dyn TYPE REF TO IF_XMS_MSGHDR30_DYNAMIC,        lv_payxstr TYPE xstring,        lv_dynxstr TYPE xstring.  DATA: persist TYPE REF TO cl_xms_persist.  DATA: ixmlfactory TYPE REF TO if_ixml,            iparser TYPE REF TO if_ixml_parser,            streamfactory TYPE REF TO if_ixml_stream_factory,            istream TYPE REF TO if_ixml_istream,            idocument TYPE REF TO if_ixml_document,            lv_xpath TYPE string,            root TYPE REF TO if_ixml_element,            el   TYPE REF TO if_ixml_element,            vl   TYPE string            .  DATA: msgguid  LIKE idxsndpor-GUID,        pid      LIKE SXMSMSGLST-PID.* Find PID  SELECT single pid from SXMSPEMAS    into pid  where    MSGGUID = msgid.* Prevent dumps on wrong message-ids  IF SY-SUBRC <> 0.    VALUE = ‘ ‘.    return.  ENDIF.* Create basic objects  TYPE-POOLS: ixml.  CLASS cl_ixml DEFINITION LOAD.  ixmlfactory = cl_ixml=>create( ).  streamfactory = ixmlfactory->create_stream_factory( ).  CREATE OBJECT persist.* Get Last version number  DATA:last type SXMSLSQNBR.  CALL METHOD persist->find_last_version_pub    EXPORTING      im_msgguid   = msgid      im_pid       = pid    IMPORTING      last_version = last.* Get XI message  CALL METHOD persist->read_msg_pub    EXPORTING      im_msgguid      = msgid      im_pid          = pid      im_version      = last                    ” we take the last version    IMPORTING      ex_message      = li_ifmsg      ex_last_version = last.* Get total attachments number*  DATA: size type i.*  CALL METHOD li_ifmsg->numberofattachments*    RECEIVING*      size = size.* Collect Dynamic Configuration Data  li_msg ?= li_ifmsg.  li_pay = li_msg->get_payload_with_main_document( ).  li_dyn = li_msg->GET_DYNAMIC_HEADER( ).  DATA: records type SXMS_MSGHDR30_DYNAMIC_T,        begin of wa,          PARAM_NAMESPACE type SXMS_DYN_CONF_NS,          PARAM_NAME TYPE SXMS_DYN_CONF_NAME,          PARAM_VALUE TYPE SXMS_DYN_CONF_VALUE,        end of wa.  records = li_dyn->GET_RECORDS( ).* Find Dynamic Configuration Record  READ TABLE records WITH TABLE KEY    PARAM_NAMESPACE = NAMESPACE    PARAM_NAME = ATTR      INTO wa .* Return parameter’s value from Dynamic Configuration  IF SY-SUBRC = 0.    VALUE = WA-PARAM_VALUE.  ELSE.    VALUE = ‘ ‘.  ENDIF.ENDFUNCTION.

Set 3 input parameters as specified in the header of the function:
MSGID of type  MPG_GUID – this will be the message GUID
NAMESPACE of type STRING – the attribute namespace
ATTR of type  STRING – the attribute name

The output will be in the VALUE field, and will contain the value of the attribute we chose.

Save and activate when finished.

 2. Now we have to copy the standard structure SXMSMSGDSP. Run transaction se11, insert SXMSMSGDSP as “Database Table” then click copy. Choose a different name for the structure (e.g. ZMONI_SXMSMSGDSP) and click the tick.

Insert the package you created in the previous step and click the tick again. Now that we’ve copied the structure let’s insert a new filed. This field is going to contain the filename attribute of each message. I called it DYNFIELD1. Click on the “Insert row” button and fill in the field name and type.

I used a CHAR100 which is surely large enough to contain a filename. 

You can also add more fields here to show additional stuff as I said at the beginning of this blog. When you’re done, save and activate (when I did it, I got a package check error. If the same happens to you just ignore it and select yes to activate anyway).

3. Here comes the hard part, we have to edit the standard program  which lies under transaction SXI_MONITOR. To do this we’ll again rely on The specified item was not found.. Use transaction se80 to copy the standard program, we don’t need either to copy every included program but only RSXMB_SEL_MSG_TOP and RSXMB_SEL_MSG_APPL (which contains the “core” part). Copy those two programs to a name of your choice starting with ‘Z’. I used the names ZENR_RSXMB_SEL_MSG_TOP and ZENR_RSXMB_SEL_MSG_APPL.

First edit ZENR_RSXMB_SEL_MSG_TOP changing just the following 2 lines:

DATA: gs_msgtab_ext TYPE SXMSMSGDSP.DATA: gt_msgtab_ext TYPE STANDARD TABLE OF sxmsmsgdsp.

to

DATA: gs_msgtab_ext TYPE zmoni_sxmsmsgdsp.DATA: gt_msgtab_ext TYPE STANDARD TABLE OF zmoni_sxmsmsgdsp.

Here we are basically telling XI to use our structure instead of his. Now we have to edit the program ZENR_RSXMB_SEL_MSG_APPL.

First of all change every occurrence of the data type SXMSMSGDSP to ZMONI_SXMSMSGDSP (just do a case insensitive “replace all”). Then add, at the end of the program, after the last line of code, the following form:

FORM SET_FILENAME.  DATA: wa_name type SXMS_DYN_CONF_VALUE,      lt_msgtab_ext TYPE zmoni_sxmsmsgdsp.  LOOP AT gt_msgtab_ext into lt_msgtab_ext.*   Get FileName from Dyn Conf    CALL FUNCTION ‘Z_ITBC_GET_MSG_REF’      EXPORTING        MSGID           = lt_msgtab_ext-MSGGUID        NAMESPACE       = ‘http://sap.com/xi/XI/System/File’        ATTR            = ‘FileName’     IMPORTING        VALUE           = wa_name          .    lt_msgtab_ext-DYNFIELD1 = wa_name.    MODIFY gt_msgtab_ext FROM lt_msgtab_ext.  ENDLOOP.ENDFORM.

This form will fetch the filename attribute and fill our custom output field with that value for every message. We have to call the form twice. Add the following:

PERFORM SET_FILENAME.

right before this line (line 983 of the original program):

* display the message list

and right after this line (line 1469 of the original program):

METHOD refresh.

Now we’re almost done, but we have to modify the fieldcatalog in order to display the field we added. Find the line

CASE gs_fieldcat-fieldname.

and right after that add

*      Change        WHEN ‘DYNFIELD1’.                          ” fieldname from dyn conf          IF g_grid_view = c_process_view.            gs_fieldcat-col_pos    = 1.          ELSE.            gs_fieldcat-col_pos    = 1.            ” this field will be the first one          ENDIF.          gs_fieldcat-coltext    = text-Z01.          gs_fieldcat-seltext    = text-Z02.          gs_fieldcat-just       = ‘L’.

We are almost there, just go to the menu and select “Goto > Text Elements > Text Symbols”.

Here we can add the description and a tooltip for our custom field. Insert the value “FileName” under for the key “Z01”, and “File Name” for the key “Z02”. Then save and activate as usual.

Ok, that’s it. Test your application by clicking F8. Enter a nonempty selection criterion and you should get something like:

Improvements

Try it out and consider adding some more functionalities to this, surprisingly enough there is very little ABAP coding involved, but it depends on which kind of data you want to display 😉

____________________

¹ Actually if the file is created after the message mapping, you’ve got almost no chances to know its name beforehand. But, sometimes, your source system could impose the name of the file to the target system, and in this case (which was my case), you can have it and use it as you like (for example you can put it in the dynamic configuration ;-D ). In this situation you won’t be able to see the file name in the first version of the message, but in the last one you can.