How to Create a Retain Worker SOAP Trace for Exchange Jobs

  • 7019135
  • 04-Aug-2014
  • 07-Aug-2017

Environment


Retain 3.x
Microsoft Exchange

Situation


My jobs are not archiving all items but I cannot see what is wrong by looking at the RetainWorker log.  Is there a way to create a SOAP trace in order to see the entire communication between the Worker and Exchange Web Services (EWS)?

Resolution


Yes, a SOAP trace can be set up in the Retain Worker:


Linux
1.  Navigate to /opt/beginfinite/retain/RetainWorker/WEB-INF/classes/config (the path is red is the default path, yours could be different if you customized it during the initial install).

2.  Edit the file, "attachment.properties", and search for "disablegzip".

3.  Uncomment the following two entries (by deleting the two pound symbols "##" preceding them) and change their values to read as follows:
exchange.ews.disablegzip=1
exchange.soap.tracedir=/tmp
 
NOTE: 

The "tracedir" directory can be left at the default value of "/tmp", but if so, make sure that the directory exists before running the trace.

Or you can use any directory name you wish and place it in any path you wish, but that path and directory must exist prior to running the trace.  Since there are other files that go to the /tmp directory, creating a directory just for the capture of SOAP traces might be easier.  If you decide to use your own unique directory, assign Tomcat as the directory owner.

The SOAP trace files will be created in this directory. 

There will be one file for EVERY mailbox processed named soap[nnnnnnnnnnnnnn].log (where "n" is a number).

4.  Save your changes.

5.  Edit the file, "exchange.properties", and edit the following line to read as follows:

ews.disablegzip = 1

6.  Save your changes

7.  Restart Tomcat.

8.  Start the archive job.  Again, there will be a SOAP trace file for every mailbox processed, so Support may need each file.

Windows
1.  Navivate to [C]:\Program Files\Beginfinite\retain\RetainWorker/WEB-INF/classes/config (the path is red is the default path, yours could be different if you customized it during the initial install).

2.  Edit the file, "attachment.properties", and search for "disablegzip".

3.  Uncomment the following two entries (by deleting the two pound symbols "##" preceding them ) and change their values to read as follows:exchange.ews.disablegzip=1
exchange.soap.tracedir=c:\\trace

NOTE: 

  • The "tracedir" directory defaults to "/tmp", which would be an invalid path and directory on a Windows server.   Change this directory to any directory name you wish and place it in any path you wish, but that path and directory must exist prior to running the trace.  The SOAP trace files will be created in this directory. 
  • There will be one file for EVERY mailbox processed named soap[nnnnnnnnnnnnnn].log (where "n" is a number).
  • The double backslashes "\\" following the drive letter is not a typing error.  You must type in double backslashes.

4.  Save your changes.

5.  Edit the file, "exchange.properties", and edit the following line to read as follows:

ews.disablegzip = 1

6.  Save your changes

7.  Restart Tomcat.

8.  Start the archive job.  Again, there will be a SOAP trace file for every mailbox processed, so Support may need each file.
See also, "SOAP Trace Reading Basics".

Additional Information

This article was originally published in the GWAVA knowledgebase as article ID 2321.

Feedback service temporarily unavailable. For content questions or problems, please contact Support.