SOAPe’s log viewer allows you to analyse EWS trace logs quickly and identify errors or pinpoint particular events.  This article will describe most of the features available.

Loading Logs

When you first open the log viewer, you will see any EWS data that SOAPe has seen since it was started (data from previous sessions is not shown). To load data that was created in a previous SOAPe session, you can click Reload Log. This will parse the complete SOAPe log file and display the information.

If you are analysing logs created by another application, you can use Load Log… to load the trace file. Depending upon size, it may take a little time for the log to be loaded and parsed. SOAPe can handle quite large logs, the maximum size dependent upon available memory. You can open multiple log windows if you want to view different logs at the same time.

The Load Log… option can be used to open any file (e.g. .log, .txt, or any other name). Any EWS traces that SOAPe recognises will be parsed. For SOAPe to recognise the trace, it needs to have each trace element identified by <trace> tags (as per the trace output of the EWS Managed API). If the trace does not contain these tags, then SOAPe may not be able to parse the trace (there is some logic to find EWS data outside <trace> tags, but it is not very robust).

SOAPe can also load all logs found in a particular folder. To do this, click Load log folder… and then select the folder containing the logs. SOAPe will load all .xml files from this folder and attempt to parse them as EWS data – if successful, the log will be added to the viewer.

Once the log has been loaded, any errors that SOAPe recognises (it looks for HTTP errors and also error responses in the Xml) will be highlighted in red. Note that if you are looking at an EWSEditor log, you will see a ConvertId error for each EWSEditor session. This can be ignored, as EWSEditor sends an invalid ConvertId request when initialising the folder hierarchy.

Sorting and Filtering

SOAPe supports sorting data by any of the displayed columns.  By default, the log is sorted by the Date/Time column.  To sort on another column, click the column header.  The first click will sort by that column ascending, and a second click will change the sort order to descending.

The filter can be used for more advanced searching.  To set the filter, click Filter… to open the filter window. Any of the columns can be searched, including the EWS data (which will be the Xml, or HTTP headers).  For example, if you wanted to find any request that included publicfoldersroot, you could add a LIKE query on the data column:

 SOAPe Filter Dialog

Clicking Apply will update the log window and display any matching entries.  In the above example, any Xml request or response that contains the text publicfoldersroot will be shown.  Note the asterisk before and after the text.

To clear the filter, open the filter window and select Clear, then Apply.

Xml Analysis and Editing

All the SOAPe windows that show data (e.g. Xml) have a context menu that control how Xml is displayed and also provide some shortcuts for common operations:

SOAPe Xml Options

Last edited Feb 10 at 1:38 PM by purplepomegranite, version 2


No comments yet.