KFS 4.3 Debug Logs that include logging for Active Directory login issues
Article # 3031424 - Page views: 80
Issue
How to Enable Kofax Front Office Server (KFS) 4.3 Debug Logging that includes logging for Active Directory login issues
Solution
KFS 4.3 logs events for both user-facing (webapp) and server-side (service) processes. It is often necessary to enable debug-level logging for both types of events for the purposes of comprehensive troubleshooting. Additional steps are required to enable Active Directory (AD) Login debug logging.
Enabling Debug Logging with AD Login Debugging in KFS 4.3
- Navigate to
C:\Program Files (x86)\Kofax\Front Office Server 4.3\bin
.
- Open the
log4net.config
file in a text editor, such as Notepad.
- Locate the section that begins with
<appender name="KfsLog"
<appender name="KfsLog" type="log4net.Appender.RollingFileAppender"> <file type="log4net.Util.PatternString" value="%property{LogFolder}/%property{LogFile}" /> <encoding value="utf-8" /> <rollingStyle value="Size" /> <maxSizeRollBackups value="10"/> <maximumFileSize value="100MB" /> <layout type="log4net.Layout.PatternLayout"> <!-- Note: Use comma separator for milliseconds to match 3.5 format. Required for Kofax Monitor --> <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss,fff} %-5level [%thread] %logger - %message%newline" /> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <levelMin value="INFO" /> <levelMax value="FATAL" /> </filter> </appender>
- In the
KfsLog
section, change the levelMin value fromINFO
toDEBUG
.<appender name="KfsLog" type="log4net.Appender.RollingFileAppender"> <file type="log4net.Util.PatternString" value="%property{LogFolder}/%property{LogFile}" /> <encoding value="utf-8" /> <rollingStyle value="Size" /> <maxSizeRollBackups value="10"/> <maximumFileSize value="100MB" /> <layout type="log4net.Layout.PatternLayout"> <!-- Note: Use comma separator for milliseconds to match 3.5 format. Required for Kofax Monitor --> <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss,fff} %-5level [%thread] %logger - %message%newline" /> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <levelMin value="DEBUG" /> <levelMax value="FATAL" /> </filter> </appender>
- Locate the section that begins with
<logger name="Kofax.KFSLib.Security.ADQueryHelper"
<logger name="Kofax.KFSLib.Security.ADQueryHelper"> <level value="INFO" /> </logger>
- Change the level value from
INFO
toDEBUG
<logger name="Kofax.KFSLib.Security.ADQueryHelper"> <level value="DEBUG" /> </logger>
- Locate the section that begins with
<logger name="Kofax.KFS.Security.SecurityHelper"
<logger name="Kofax.KFSLib.Security.SecurityHelper"> <level value="INFO" /> </logger>
- Change the level value from
INFO
toDEBUG
<logger name="Kofax.KFSLib.Security.SecurityHelper"> <level value="DEBUG" /> </logger>
- Save and close the file.
- Navigate to
C:\Program Files (x86)\Kofax\Front Office Server 4.3\kfsService
.
- Open the
log4net.config
file in a text editor, such as Notepad.
- Locate the section that begins with
<appender name="KfsLog"
<appender name="KfsLog" type="log4net.Appender.RollingFileAppender"> <file type="log4net.Util.PatternString" value="%property{LogFolder}/%property{LogFile}" /> <encoding value="utf-8" /> <rollingStyle value="Size" /> <maxSizeRollBackups value="10"/> <maximumFileSize value="100MB" /> <layout type="log4net.Layout.PatternLayout"> <!-- Note: Use comma separator for milliseconds to match 3.5 format. Required for Kofax Monitor --> <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss,fff} %-5level [%thread] %logger - %message%newline" /> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <levelMin value="INFO" /> <levelMax value="FATAL" /> </filter> </appender>
- Change the levelMin value from
INFO
toDEBUG
.<appender name="KfsLog" type="log4net.Appender.RollingFileAppender"> <file type="log4net.Util.PatternString" value="%property{LogFolder}/%property{LogFile}" /> <encoding value="utf-8" /> <rollingStyle value="Size" /> <maxSizeRollBackups value="10"/> <maximumFileSize value="100MB" /> <layout type="log4net.Layout.PatternLayout"> <!-- Note: Use comma separator for milliseconds to match 3.5 format. Required for Kofax Monitor --> <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss,fff} %-5level [%thread] %logger - %message%newline" /> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <levelMin value="DEBUG" /> <levelMax value="FATAL" /> </filter> </appender>
- Locate the section that begins with
<logger name="Kofax.KFSLib.Security.ADQueryHelper"
<logger name="Kofax.KFSLib.Security.ADQueryHelper"> <level value="INFO" /> </logger>
- Change the level value from
INFO
toDEBUG
<logger name="Kofax.KFSLib.Security.ADQueryHelper"> <level value="DEBUG" /> </logger>
- Locate the section that begins with
<logger name="Kofax.KFS.Security.SecurityHelper"
<logger name="Kofax.KFSLib.Security.SecurityHelper"> <level value="INFO" /> </logger>
- Change the level value from
INFO
toDEBUG
<logger name="Kofax.KFSLib.Security.SecurityHelper"> <level value="DEBUG" /> </logger>
- Save and close the file.
- Repeat the above steps for each KFS server in the environment.
All KFS 4.3 logs are stored in the following folder:
C:\ProgramData\Kofax\Front Office Server\Log
Disabling Debug Logging with AD Login Debugging in KFS 4.3
- Navigate to
C:\Program Files (x86)\Kofax\Front Office Server 4.3\bin
.
- Open the
log4net.config
file in a text editor, such as Notepad.
- Locate the section that begins with
<appender name="KfsLog"
<appender name="KfsLog" type="log4net.Appender.RollingFileAppender"> <file type="log4net.Util.PatternString" value="%property{LogFolder}/%property{LogFile}" /> <encoding value="utf-8" /> <rollingStyle value="Size" /> <maxSizeRollBackups value="10"/> <maximumFileSize value="100MB" /> <layout type="log4net.Layout.PatternLayout"> <!-- Note: Use comma separator for milliseconds to match 3.5 format. Required for Kofax Monitor --> <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss,fff} %-5level [%thread] %logger - %message%newline" /> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <levelMin value="DEBUG" /> <levelMax value="FATAL" /> </filter> </appender>
- In the
KfsLog
section, change the levelMin value fromDEBUG
toINFO
.<appender name="KfsLog" type="log4net.Appender.RollingFileAppender"> <file type="log4net.Util.PatternString" value="%property{LogFolder}/%property{LogFile}" /> <encoding value="utf-8" /> <rollingStyle value="Size" /> <maxSizeRollBackups value="10"/> <maximumFileSize value="100MB" /> <layout type="log4net.Layout.PatternLayout"> <!-- Note: Use comma separator for milliseconds to match 3.5 format. Required for Kofax Monitor --> <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss,fff} %-5level [%thread] %logger - %message%newline" /> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <levelMin value="INFO" /> <levelMax value="FATAL" /> </filter> </appender>
- Locate the section that begins with
<logger name="Kofax.KFSLib.Security.ADQueryHelper"
<logger name="Kofax.KFSLib.Security.ADQueryHelper"> <level value="DEBUG" /> </logger>
- Change the level value from
DEBUG
toINFO
<logger name="Kofax.KFSLib.Security.ADQueryHelper"> <level value="INFO" /> </logger>
- Locate the section that begins with
<logger name="Kofax.KFS.Security.SecurityHelper"
<logger name="Kofax.KFSLib.Security.SecurityHelper"> <level value="DEBUG" /> </logger>
- Change the level value from
DEBUG
toINFO
<logger name="Kofax.KFSLib.Security.SecurityHelper"> <level value="INFO" /> </logger>
- Save and close the file.
- Navigate to
C:\Program Files (x86)\Kofax\Front Office Server 4.3\kfsService
.
- Open the
log4net.config
file in a text editor, such as Notepad.
- Locate the section that begins with
<appender name="KfsLog"
<appender name="KfsLog" type="log4net.Appender.RollingFileAppender"> <file type="log4net.Util.PatternString" value="%property{LogFolder}/%property{LogFile}" /> <encoding value="utf-8" /> <rollingStyle value="Size" /> <maxSizeRollBackups value="10"/> <maximumFileSize value="100MB" /> <layout type="log4net.Layout.PatternLayout"> <!-- Note: Use comma separator for milliseconds to match 3.5 format. Required for Kofax Monitor --> <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss,fff} %-5level [%thread] %logger - %message%newline" /> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <levelMin value="DEBUG" /> <levelMax value="FATAL" /> </filter> </appender>
- In the
KfsLog
section, change the levelMin value fromDEBUG
toINFO
.<appender name="KfsLog" type="log4net.Appender.RollingFileAppender"> <file type="log4net.Util.PatternString" value="%property{LogFolder}/%property{LogFile}" /> <encoding value="utf-8" /> <rollingStyle value="Size" /> <maxSizeRollBackups value="10"/> <maximumFileSize value="100MB" /> <layout type="log4net.Layout.PatternLayout"> <!-- Note: Use comma separator for milliseconds to match 3.5 format. Required for Kofax Monitor --> <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss,fff} %-5level [%thread] %logger - %message%newline" /> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <levelMin value="INFO" /> <levelMax value="FATAL" /> </filter> </appender>
- Locate the section that begins with
<logger name="Kofax.KFSLib.Security.ADQueryHelper"
<logger name="Kofax.KFSLib.Security.ADQueryHelper"> <level value="DEBUG" /> </logger>
- Change the level value from
DEBUG
toINFO
<logger name="Kofax.KFSLib.Security.ADQueryHelper"> <level value="INFO" /> </logger>
- Locate the section that begins with
<logger name="Kofax.KFS.Security.SecurityHelper"
<logger name="Kofax.KFSLib.Security.SecurityHelper"> <level value="DEBUG" /> </logger>
- Change the level value from
DEBUG
toINFO
<logger name="Kofax.KFSLib.Security.SecurityHelper"> <level value="INFO" /> </logger>
- Save and close the file.
- Repeat the above steps for each KFS server in the environment.
Level of Complexity
Moderate
Applies to
Product | Version | Build | Environment | Hardware |
---|---|---|---|---|
Kofax Front Office Server | 4.3 | All | All | N/A |
References
N/A
Article # 3031424