All configurations for logging in iManage Work Desktop for Windows are specified in the LogConfig.xml file, which is located at the root install path for iManage Work Desktop for Windows. You can customize many aspects of logging for iManage Work Desktop for Windows. By default, iManage Work Desktop for Windows retains the last ten log files per application, up to 10 MB in size each. Microsoft Outlook, Word, Excel, PowerPoint, Project, Visio and Adobe Acrobat are the applications supported.

The most commonly-adjusted configuration is at the log level, documented in the following text. You can specify a change in the log level by opening the log file as an administrator, and changing the level value property (refer to the Log values section below).

<logger name="WorkSiteLog"> <level value="INFO" /> <appender-ref ref="LogFileAppender" /> </logger>

NOTE:

The components in the iManage Agent Services install package, such as iManage Update Manager Service read the copy of LogConfig.xml located in %ProgramData%\iManage\AgentServices\configs. To configure the log level for iManage UpdateManagerService and iManageStayExec, copy the edited version of the LogConfig.xml file to %ProgramData%\iManage\AgentServices\configs.

Log values

  • ALL: Maximum verbosity

  • DEBUG: Debugging information is reported

  • INFO: Information level events and above are reported (Default value)

  • WARN: Warnings and errors are reported

  • ERROR: Errors are reported

  • FATAL: Only serious failure events are reported

  • OFF: No logging

Changes made to the logging level are immediately in running applications and do not require an application restart.

Log file location

The local storage location for log files is specified in the following section of LogConfig.xml:

<file type="log4net.Util.PatternString"> <conversionPattern value="${LOCALAPPDATA}\iManage\Work\Logs\%property{ExeName}.iManage.Work.log-"/> </file>

$ {LOCALAPPDATA}\iManage\Work\Logs\ specifies the local path where log files are stored.

NOTE:

You should always store log files at a local storage location for performance reasons. Log files shouldn't be located on a shared network drive.

%property{ExeName} must be retained as part of the log file name, to ensure that logging is segregated across application processes.

Maximum log file size

The following setting specifies the maximum size for a log file: <maximumFileSize value="10MB" />

iManage Work Desktop for Windows uses the common logging library Log4net for logging support. Log4net supports an extensive set of advanced configuration capabilities. For more information about Apache documentation for Log4Net go to https://logging.apache.org/log4net/release/manual/configuration.html.

Maximum days to retain log files

The following setting specifies the maximum number of days for which logs are retained before deleting: <maxSizeRollBackups value="30" />. To change the number of days for which log files are retained, specify a number greater than 0 (zero). To disable deletion of log files, specify a negative number.

The application automatically deletes the files at the specified log file location that are older than the number of days specified in the setting.

NOTE:

  • A single application can now create up to 30 log files of 10 MB each. Also, the deletion logic is optimized to ensure that scanning for old log files isn't done more than once a day.

  • This feature isn't available if you customize the LogConfig.xml file extensively, change rollingStyle, or don't use RollingFileAppender. In such scenarios, the native log file deletion functionality available in Apache log4net applies.

Select error reporting to Azure Application services

From version 10.6.0 onwards, cloud logging for select errors is enabled in iManage Work Desktop for Windows. The trace information, sent to Azure ApplicationInsights Services hosted by iManage, is used to identify the following issue areas and sources:

  • Health checking errors

  • iManage Work web checkpoint traces (info level and above)

  • iManage Work web health checking notifications

  • Microsoft WebView2 browser console errors

  • Microsoft WebView2 browser process and navigation errors

  • User actions on error banner

NOTE:

No user information is shared with Azure ApplicationInsights Services hosted by iManage. 

The errors shared are only for production environments. You can use the iwTestServerDomains configuration available in imWorkOptions.xml file to identify non-production servers that have the data analytics feature enabled. For non-production servers, iManage Work Desktop for Windows doesn't send error logs to Azure ApplicationInsights Services. For more information about this configuration, refer to the imWorkOptions.xml section in iManage Work Desktop for Windows Customization Guide.  

This feature is enabled by default and can be turned off by using the LogConfig.xml file. For detailed information about how to disable this feature, refer to the Disabling cloud logging for select errors section in iManage Work Desktop for Windows Customization Guide

Log files

The following is a list of log files that you can review to troubleshoot issues, if any:

For...

Refer to

At...

Issues related to installation and uninstallation errors

workdesktop.log

  • C:\Windows\Temp
    (when installation is managed by the system—for example, iManage Auto Updates)

  • %localappdata%\Temp
    (when installation is managed by user or admin profiles)

Issues related to Auto Updates notifications

iwAgent.10.9.x.x.iManage.Work.log

%LocalAppData%\iManage\Work\Logs

iwlnrl.10.9.x.x.iManage.Work.log

%LocalAppData%\iManage\Work\Logs

Issues related to:

  • Communication between iManage Work and iManage Work Desktop for Windows

  • Download of config files and templates

iwAgentBackground.10.9.x.x.iManage.Work.log

%LocalAppData%\iManage\Work\Logs

Issues related to:

  • Email filing (Send and File)

  • Inbox filer

  • Mapped folders

iwWCS.10.9.x.x.iManage.Work.log

%LocalAppData%\iManage\Work\Logs

Issues related to:

  • Email filing

  • Filing suggestions and status

  • iManage Work Panel

  • Inserting and saving attachments

OUTLOOK.10.9.x.x.iManage.Work.log

%LocalAppData%\iManage\Work\Logs

Issues related to the executables in the process registry folder

iManageStayExec.10.9.x.x.iManage.Work.log

%localappdata%\iManage\AgentServices\Logs

Issues about products not getting upgraded to the desired version

iManageUpdateManager.10.9.x.x.iManage.Work.log

%ProgramData%\iManage\AgentServices\Logs

Issues with Auto Updates

iManageUpdateScript.10.9.x.x.iManageUpdater.log

iManageUpdaterRest.10.9.x.xx.iManage.Work.<date>.log

iManageFinalizer.10.9.x.xx.iManage.Work.<date>.log

iManageUpdateManagerService.10.9.x.xx.iManage.Work.<date>.log

iManageUpdaterToast.10.9.x.xx.iManage.Work.admin.<date>.log

iwa.10.9.x.xx.iManage.Work.<date>.log

%ProgramData%\iManage\AgentServices\Logs