Question:
How to activate Windows Explorer Client Debug logging?
Answer:
Windows Explorer Client, starting from DocuWare 6, has the ability to log valuable information during its work. It uses the standard DocuWare Logging Mechanism. This means that the configuration and the parameters inside the configuration have the same meaning as they are in the other DocuWare applications.
Till DocuWare Version 6.7
To enable the configuration an additional section has to be placed in the settings file of the Windows Explorer Client (DocuWare.WindowsExplorerClient.dll.settings). This settings file is located in %localappdata%\DocuWare\WEC. To enable the logging the following configuration should be entered just before the closing tag:
<UserSettings>
……
<loggingManagement mode="on" trace="on">
<loggingModule assembly="DocuWare.WindowsExplorerClient">
<publisher assembly="DocuWare.Common" type="DocuWare.Common.Logging.FilePublisher" logLevel="Debug" fileName="C:\DWWECLog.log" maxFileSize="30000" enhancementMethod="newFile" maxFileNumber="50" />
</loggingModule>
</loggingManagement>
Probably the most important options in the configuration are fileName and logLevel. The first one points to the path where the configuration file is created. This should be a place where the user currently logged in Windows user has write access. The second one points the level of configuration which will be enabled. Debug is the preferred level, as this will show all the logs during the application's work.
There is something crucial for Windows Explorer Client's log to work. The GAPI logging configuration has to be removed (or commented out). The appropriate configuration file for this is located in the installation folder of the Windows Explorer Client "DocuWare.Gapi.dll.config". This is the default content of GAPI’s config file:
<configuration>
<configSections>
<section name="GapiConfig" type="DocuWare.Gapi.Client.GapiConfigHandler, DocuWare.Gapi"/>
<section name="loggingManagement" type="DocuWare.Common.Logging.LoggingManagerSectionHandler,DocuWare.Common"/>
</configSections>
<runtime>
<legacyUnhandledExceptionPolicy enabled="true" />
</runtime>
<appSettings>
<add key="DetailedErrors" value="off"/>
</appSettings>
<GapiConfig SettingsStorage="DocuWare.Gapi.dll.settings" ObjectLifeTime="1000" CachedSelectlistLength="200" BitmapTransparencyType="Color" DefaultTrueTypeFont="Arial"/>
<loggingManagement mode="off"/>
</configuration>
The bold line above (loggingManagement tag) should be commented out or removed, for example like this:
<!-- <loggingManagement mode="off"/> -->
Although by default the logging is turned off, GAPI still initializes its logger and, because of the way the logging mechanism is implemented, this will disable Windows Explorer Client's logger. If this is not done, the log of the Windows Explorer Client will be filled with GAPI communication information. And this not what we want!
The GAPI configuration file is located inside Windows Explorer Client installation folder (C:\Program Files\DocuWare\Windows Explorer Client) and it is specific for it. This change will NOT harm other DocuWare applications.
Since DocuWare Version 6.8:
The logging is activated allways. Only errors will be written. In case of analysing the logging could expand to a debug logging. Open the file DocuWare.PlatformUIProcess.exe.config at the Windows Explorer Client installation path (per default: C:\Program Files\DocuWare\Windows Explorer Client).
Locate the TAG <loggingManagement> and the parameter logLevel="Error".. Change the parameter value "Error" with the value Debug".
The parameter fileName contain the path of the logging file.
As default it is "%TEMP%\DocuWare\Logs\PlatformUIProcess.log".
After saving the changes are active at once. You don't have to restart anything.