All configurations for logging in iManage Work Desktop for Windows are specified in the LogConfig.xml file, which is located in the root install path for the iManage Work Desktop for Windows client. You can customize many aspects of logging for the iManage Work Desktop for Windows client. By default, the iManage Work Desktop for Windows client 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 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.

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

NOTE:

The iManage UpdateManagerService reads 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 the following location: %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 to the configured logging level take effect 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 in a local storage location for performance reasons. Log files should not be located on a network share.

%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 of each 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, refer to the Apache documentation for Log4net by visiting the following web page:

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" />

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

NOTE:

Previously this parameter was set to 10 by default. In iManage Work Desktop for Windows 10.2.3 or later, this is changed to 30. Up to 30 log files can be created now, each 10MB in size, from a single application. Also, the deletion logic is optimized to ensure that the scanning for old log files is not done more than once a day.
This feature is not available if you customize the LogConfig.xml extensively, change the rollingStyle, or do not use the RollingFileAppender. In such scenarios, the native log file deletion functionality available in Apache log4net applies.

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.

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 following tracing information is sent to Azure ApplicationInsights Services hosted by iManage. This information is used to identify the problem areas or source of the problem.

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

IMPORTANT:

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 data analytics feature enabled. If is a non-production server, then iManage Work Desktop for Windows does not send the error logs to Azure ApplicationInsights Services. For more information about this configuration, refer to imWorkOptions.xml section in iManage Work Desktop for Windows Customization Guide.

This feature is enabled by default and can be disabled 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.