You can configure IBM® Content
Navigator for Microsoft Office logging
from the IBM Content
Navigator administration
tool. When an error occurs in IBM Content
Navigator for Microsoft Office,
the log file on the client machine is updated.
About this task
The location of the logged information on the client machine varies depending on the logging
level that you specify. Debug logging information is written only to the IBM Content
Navigator for Microsoft Office log files. Less detailed logging information, which includes
errors, warnings, and informational messages, is written to the log files and to the Microsoft
Windows Event Viewer in the Application Log.
- Microsoft Windows Event Viewer in the Application Log
- If you specify Error logging, information
is written to the Microsoft Windows Even Viewer in the Application
Log and is stored in one of the following files on the client machine:
- ICNExcelAddin
- ICNOutlookAddin
- ICNPowerPointAddin
- ICNWordAddin
- IBM Content
Navigator for Microsoft Office log files
- If you specify Error, Warning, Information,
or Debug logging, information is written to
the log files in the IBM Content
Navigator for Microsoft Office application
data directory on the client machine:
- On Microsoft Windows XP, the default directory
is C:\Documents and Settings\user_account\Application
Data\IBM\Content Navigator for Microsoft Office, where
the user_account directory is the current user.
- On Microsoft Windows 7 and Windows Vista, the default directory is C:\Users\user_account\AppData\Roaming\IBM\Content
Navigator for Microsoft Office, where the user_account directory
is the current user.
The logging information for each Microsoft Office application is stored
in a separate log file:
- ICNExcelAddin.log
- ICNOutlookAddin.log
- ICNPowerPointAddin.log
- ICNWordAddin.log
By default, IBM Content
Navigator for Microsoft Office is
configured to log at the Warning level.
Procedure
To configure logging for IBM Content
Navigator for Microsoft Office:
- Open the IBM Content
Navigator administration
tool.
- Click Settings.
- Click the Logging tab.
- In the Office logging section, set
the level of logging information to write to the log files on the IBM Content
Navigator for Microsoft Office client machines:
| Logging level |
Description |
|---|
| No logging |
This setting disables IBM Content
Navigator for Microsoft Office logging. |
| Error |
This setting records information about unfulfilled requests
and internal errors.
Error-level logging can provide information
that the program encountered unrecoverable errors and must stop operating
immediately, or that the program encountered recoverable errors but
can continue operating.
|
| Warning |
Warning-level logging is the default setting. This setting
records all error messages, actions that the system administrator
must take, and information about system conditions, such as insufficient
disk space.
Warning message logging provides information that
the program detected a problem but was able to continue operating
normally.
|
| Information |
This setting records all warning messages and significant
event messages, such as successful connection to the server.
|
| Debug |
This setting records diagnostic information from the server.
Debug-level
logging provides parameters, return data information, and output information
that is used to debug errors.
Important: Do not enable
debug logging in a production environment. It can negatively affect
system performance and it enables users to view server messages in
the web client.
You can set debug logging to a particular user,
set of users, host computer, or set of host computers by specifying
those users or hosts in the debug logging settings. |
Tip: If you know that a problem does not occur for
a specific Java class or package, you can exclude classes or packages
from your log. Similarly, if you want to enable logging for only a
subset of packages or classes, you can specify particular packages
or classes to include in your log file.
- You can modify the maximum size of the IBM Content
Navigator for Microsoft Office log file.
When
the size of the file exceeds the value that you specify, the log file
is archived and a new file is created. The archived file has the following
format: ICNApplicationAddin-yyyyMMdd-increment.log. .
For example, ICNExcelAddin-20121116-5.log is
the fifth log file that is created for the Microsoft Excel application and was created
on 16 November 2012.
The first log file that is archived has
an increment of 1, and each subsequent log file uses the next integer.
- You can show a detailed stack trace in the IBM Content
Navigator for Microsoft Office error message window
by selecting Show strack trace on dialogs.
However, it is strongly recommended that you do not enable this option
unless instructed to do so by IBM Software Support. Detailed stack trace information is logged in the error and trace log files regardless of
whether it is displayed in the IBM Content
Navigator for Microsoft Office error message
window.