Modifying log file settings using Admin Console

This topic outlines how to modify the root logger setting in the SLF4J configuration for your clock.

Note: In general, the root logger setting should only be modified with the recommendation of Infor Support. If you increase the logging detail for all packages in the clock server, then this can result in too much logging information in the log files. In most cases, it is usually advantageous to modify the log file settings for a specific package. See Updating your SLF4J logging configuration for more information on how to do this.

The root logger exists at the top of the logging configuration for SLF4J and exists outside of the scope of any custom logger that exists in the clock server. All of the other application-specific Logger objects are child objects to the root logger. If the child logger has no explicit logging level set, then it inherits the setting of the root logger.

To modify log file settings for the root logger:

  1. Select this Admin Console menu path:
    Server Actions > Edit Log File Settings

    The Edit log file settings pop-up is displayed.

  2. Modify the value of root logger to one of the these values. The values are listed in order of increasing detail for your log file:
    • ERROR: Logs all stack traces.

    • WARN: Logs all the known and handled errors that occurred in the system. This is the default value is recommended for production environments.

    • INFO: Logs status tasks performed by the system, such as polling messages received from the clocks or status messages regarding database refreshes.

    • DEBUG: Tracks every action completed by the clock. This value is used for diagnosis of issues. However this value should not be used on a regular basis as the value affects the performance of the clock and generates a large log file.

  3. This is the suggested configuration for a production environment: 
    
warn - rootLogger
info - com.infor.wfm.clock.server.db.jdbc.pool.ConnectionPool
info - com.infor.wfm.clock.server.thread.SwipeExporter
info - com.infor.wfm.clock.server.thread.TemplateExporter
info - com.infor.wfm.clock.server.db.jdbc.Database
info - com.infor.wfm.clock.server.wbsynch.InboundController
info - com.infor.wfm.clock.server.wbsynch.webservice.WSFileController
info - com.infor.wfm.clock.server.wbsynch.webservice.WSXmlController
info - com.infor.wfm.clock.server.wbsynch.webservice.WSEmployeeTimeApprovalController
info - com.infor.wfm.clock.reader
info - com.infor.wfm.clock.reader.api.bio
info - com.infor.wfm.clock.reader.work.DBPurgeWorkFactory
info - com.infor.wfm.clock.reader.work.DBUpdateWorkFactory
info - com.infor.wfm.clock.reader.work.FileUpdateWorkFactory
info - com.infor.wfm.clock.reader.work.FingerPrintExportWorkFactory
info - com.infor.wfm.clock.reader.work.ScheduleTabledumpWorkFactory
info - com.infor.wfm.clock.reader.work.TimeApprovalSynchronizationWorkFactory
info - com.infor.wfm.clock.reader.work.ReaderStatusExportWorkFactory
  4. For more detailed information about various operations and processes, you can use these settings:
    • Biometric operations such as enrollment, use DEBUG logging for com.infor.wfm.clock.api.bio.
    • Badge numbers entered by keyboard or by badge readers, use DEBUG logging for ClockFrame.

    • dbupdate process, use DEBUG logging for DBUpdateWorkFactory, WSXmlController, and InboundController.

      File update process, use DEBUG logging for WSFileController and FileUpdateWorkFactory.

    • dbpurge process, use DEBUG logging for DBPurgeWorkFactory.
    • The fingerprint export process, use DEBUG logging for FingerPrintExportWorkFactory and TemplateExporter.
    • Schedule tabledump process, use DEBUG logging for ScheduleTabledumpWorkFactory, WSXmlController, and InboundController.
    • Time approval synchronization process, use DEBUG logging for TimeApprovalSynchronizationWorkFactory and WSEmployeeTimeApprovalController.
    • Database operations, use DEBUG logging for Database.

The clock uses the SLF4J logging framework for more detailed customization of logging information. Refer to https://logback.qos.ch/ for more information.

For information on how to modify the logging configuration directly, see Updating your SLF4J logging configuration.