Skip to Content
Author's profile photo Michal Krawczyk

Michal’s PI tips: XPI inspector – help OSS and yourself

Two months ago SAP released a new tool for gathering logs and traces of different PI components called XPI inspector. It can be used by SAP OSS message processing as it allows you to gather all important logs into one zip file which can be attached to an OSS note but does it mean that only OSS can use it ? I’ll show you why it’s a nice tool for everyday use of issue tracking for any SAP XI/PI admin/developer.

*Who can install XPI inspector ?

It seems that the tool should work as of WAS 6.40 (so even with XI 3.0) up to the latest available version PI 7.3 (on which I’ve tested the tool).

How to install XPI inspector ?

Installation is very simple and requires deploying only one ear file. You can either use NWDS (from where you can deploy ear directly) or you can create and SDA file and deploy it using JSPM (if your system has JSPM). You can get the ear file from OSS note – 1514898  ( Once you deploy the ear file you can open the application using this link: http://<pi_server_host>:<J2EE_port>/xpi_inspector

How to use XPI inspector ?

Note – 1

In order to run XPI inspector you need to have administrator’s credentials for PI.

Note – 2

This tool does not do any configuration changes it only collects information. So might be safer to use then setting up all logs to Debug level and then forgetting to tutrn it back again.

Using the inspector is as simple as it gets:

1. Select an example to use (all of them are mentioned in the OSS note)

2. Select additional debug traces:

a) Messaging System

b) XI Module Processor – flow between messaging service and adapters

c) HTTP provider – (http-get and http-post communication)

d) Open SQL – DB access on Java stack

e) JCo logs – per trace level

Additional checks include:

a) SAP system state – locks, java threads, java GC info

b) Configuration <br /><br />!|height=423|alt=|width=560|src=

Depending on the use you can either select additional parameters like channel names, etc. or you can just start the XPI inspector directly.

What do we get as a result ?

We get a zipped file with all information and below you can find some examples:

a) AS Java System Properties and XI Components – as the name suggests we get all PI related properties in one place – so we can quickly compare with other systems too (like test, prd).

b) AS Java Heap Memory

c) AS Java Threads

d) you get all of the debug traces which you’ve selected on the previous screen

There is also one use case called – 100 Custom  and it allows you to select the log locations and categories which you want to log.

*Using XPI inspector for Communication channel documentation purposes *

Once you select the “by channel” use case you select all channels which need to be logged and one additional thing which will be done for you is a complete dump of the channel’s configuration.

From there you can get an HTML page with all parameters for your communication channel.


Assigned Tags

      You must be Logged on to comment or reply to a post.
      Author's profile photo Former Member
      Former Member

      Thanks for the blog. I am having issues with deploying this EAR. First I tries to convert the EAR to SDA using NWCETool and getting the following error:
      nwce>createsda -n "XPI Inspector App" -v "" -l "localhost" -c "2012." -type "J2EE" "C:\Program Files\SAP\IDE\CE\eclipse\tools\nwcetool\xpi_
      inspector_ear.ear" "C:\Program Files\SAP\IDE\CE\eclipse\tools\nwcetool\xpi_inspector"

      Conversion of C:\Program Files\SAP\IDE\CE\eclipse\tools\nwcetool\xpi_inspector_ear.ear to a SDA of type J2EE
      Info: JarSAPProcessing version 20070123.1200 / JarSL version 20070507.1400
      Error consistencyCheck: name in component definition ==> the value contains an illegal character: ' ', only following characters are allowed: 'ABCDEFGHIJKLMNOPQ
      ERROR: Wrong attribute combination!


      Author's profile photo Michal Krawczyk
      Michal Krawczyk
      Blog Post Author

      please try to deploy the ear with NWDS

      Michal Krawczyk

      Author's profile photo Nageshwar Reddy
      Nageshwar Reddy

      Thanks for the article. XPI Inspector seems to be very promising with issue analysis.

      Additional points to note;

      1. When you download the .ear file from SMP, ensure that it is saved as .ear file. In my case it was saved as .zip. You will face issues without proper extension when you deploy using NWDS.

      2. The role name that is required is "Administrator". Even NWA_SUPERADMIN will not do.

      Author's profile photo monica bhosale
      monica bhosale

      Hi Nageshwar,

         Can you please specify which exact role required for authorization? we are facing authorization issue for XPI inspector on production.



      Author's profile photo Rafael Vieira
      Rafael Vieira

      I'm having 403 error when trying to access it for the 1st time, even trying with PISUPER id which for sure has all required Admin roles.

      "You are not authorized to view the requested resource."

      Should there be a service to be activated in SICF for such tool?

      Also, is there a way to validate if the deploy was successfully done?


      Rafael Vieira.

      Author's profile photo monica bhosale
      monica bhosale

      Hi All,

        We are facing authorization issue on production , can anyone please let us know which role is needed for XPI authorization ?

      Do we need to add SAP_J2EE_ADMIN role or any other  administrator role.



      Author's profile photo Hareesh Gampa
      Hareesh Gampa

      As mentioned by Nageswar, you should have the UME role "Administrator" assigned to the user who is trying to access this.

      Author's profile photo Péter Pelyva
      Péter Pelyva

      Hi Monica, hi Hareesh,

      Please check this link for a workaround.



      Author's profile photo Srini Reddy
      Srini Reddy

      Thanks Peter. You response helped our team to get access to XPI Inspector without Admin role.

      Author's profile photo Former Member
      Former Member


      one of my channel i am not able to find under trace 50. can you help me?