Configuring Log Encoding Settings
Issue
As of ILLiad 10.0, logs for the following ILLiad components are configured to use UTF-8 encoding by default to fix an issue where some characters, such as those with diacritics and non-Latin characters, did not display correctly:
- ILLiad Client
- Customization Manager
- Staff Manager
- System Manager
- Shared Server Manager
- Web Platform
- Web API
- Web Reports
This change applies automatically only to new ILLiad 10.0 installs. If you have updated to ILLiad 10.0 from a previous version, the encoding change must be made manually to the configuration file for each log following the instructions below.
Resolution
To configure a log file to use UTF-8 encoding, add a line to that log's configuration file. Each component's log configuration file is located in that component's installation directory. Use the table below to locate each configuration file, then apply the change:
-
Locate and open the component's log configuration file in a text editing application such as Notepad++.
-
Add a line for
<encoding value="utf-8" />in the section nested under the<appender>element, for example:<appender name="RollingFile" type="log4net.Appender.RollingFileAppender">
<file value="C:\ILLiad\Logs\SystemManager.log" />
<appendToFile value="true" />
<maximumFileSize value="1MB" />
<maxSizeRollBackups value="5" />
<rollingStyle value="Size" />
<staticLogFileName value="true" />
<preserveLogFileNameExtension value="true" />
<encoding value="utf-8" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level %logger - %message%newline%exception"/>
</layout>
</appender> -
Save and close the log configuration file.
-
Repeat until all component log configuration files have been modified.
Log Configuration Files
| Component | Log Configuration File Name | Location |
|---|---|---|
| ILLiad Client | ILLiadClient.log.config | Client workstation, in the ILLiad Client installation directory (default C:\Program Files (x86)\ILLiad\) |
| Customization Manager | CustomizationManager.log.config | Client workstation, in the ILLiad installation directory (default C:\Program Files (x86)\ILLiad\) |
| Staff Manager | StaffManager.log.config | Client workstation, in the ILLiad installation directory (default C:\Program Files (x86)\ILLiad\) |
| System Manager | ILLiadSystemManager.log.config | ILLiad server, in the System Manager installation directory |
| Shared Server Manager | Shared Server Manager.log.config | ILLiad server (shared server installations), in the Shared Server Manager installation directory |
| Web Platform | ILLiadWebPlatform.log.config | ILLiad server, in the Web Platform application's App_Data directory |
| Web API | ILLiadWebApi.log.config | ILLiad server, in the Web API application directory |
| Web Reports | WebReports.log.config | ILLiad server, in the Web Reports application's App_Data directory |