Skip to main content
Waters

How to enable debug logging in NuGenesis 8 LMS - WKB16442

Article number: 16442

OBJECTIVE or GOAL

To enable debug logging in NuGenesis 8 LMS software, in order to provide detailed information to Waters Support, regarding a technical issue with LMS.

ENVIRONMENT

  • NuGenesis 8 LMS
  • Windows 7 32-bit or 64-bit, Windows Server 2008 R2 SP1 64-bit, Windows Server 2012 64-bit (only for NG8 SR2)

PROCEDURE

Debug logging in NuGenesis LMS is controlled separately within each component:

  • NuGenesis LMS clients
    1. Debug logging within the NuGenesis LMS client is controlled by a configuration file in the client's installation folder.  If the LMS client is installed directly on users' PCs, then this folder will be on the users' PCs; or if the users access LMS through Citrix, then the installation folder will be on the Citrix servers.
    2. Look for the "eln.exe.config" file within the LMS client installation folder.  Open this file in Notepad.
    3. Look for the XML tag "<priority". Set it's value to "DEBUG". The default value is "ERROR".
      • Example:<priority value="ERROR"></priority>
    4. Re-start the LMS client if it is running.
    5. The log file is named "product.log" and it will be in the logged-in user's AppData folder.  It will be in "%APPDATA%\Waters\NuGenesis LMS\8.0.3.0\" for an LMS 8 SR2 client.  If users log in through a Citrix client, then the log file will be in the user's profile folder, which may be on the Citrix server or on a central profile server.
  • Waters Image Writer
    • NuGenesis 8 SR1: create the following registry keys:
      • HKLM\Software\Waters Image Writer, Name: Log, Type: DWORD, Value: 1
      • HKLM\Software\Waters Image Writer, Name: LogDestDir, Type: String, Value: C:\tmp
    • NuGenesis 8 FR1 and later: create the path C:\tmp on the LMS client machines.  The image writer will write to a log file in C:\tmp
  • LMS SDK
    • Edit the file on the client machines: Drive:\Program Files (x86)\Waters\NuGenesis LMS SDK\ELNTK_ClientExtern.config
    • Set the level to DEBUG rather than ERROR
    • Save and close the file
  • NuGenesis LMS-Empower Interface
    • This software is typically installed on machines with an Empower client
    • There are two components: Sample Browser and Result Sender
    • Sample Browser:
      1. Edit the EmpowerSampleBrowser.exe.config in Drive:\Program Files (x86)\Waters\LMS Empower Interface
      2. Change <priority value = "ERROR"/> to <priority value="DEBUG"/>
      3. Save and close the file
      4. Close and re-open the Sample Browser if it is open
    • Result Sender:
      1. Edit the EmpowerResultsSender.exe.config in Drive:\Program Files (x86)\Waters\LMS Empower Interface
      2. Change <priority value = "ERROR"/> to <priority value="DEBUG"/>
      3. Save and close the file
      4. Close and re-open the Result Sender if it is open
  • NuGenesis LMS Server (JBOSS)
    1. Run the NuGenesis LMS Server configuration tool.  Look on the desktop and in the Start menu for shortcuts to this tool.
    2. Click the Logs entry in the configuration tool.
    3. Set the "Default log level" to DEBUG.
    4. Click Apply and Close.
    5. Restart the NuGenesis LMS Server service for the change to go into effect.
    6. The log files will be written to Drive:\WatersLMSServer\log
  • NuGenesis LMS Job Services
    • Edit the following file in Notepad:
      • C:\WatersLMSServer\actback\properties\com\creon\qdisr\properties\loggingManager.properties
    • Look for this line:
      • log4j.rootCategory=ERROR,ROOT
    • Change it to this line:
      • log4j.rootCategory=DEBUG,ROOT
    • Save and close loggingManager.properties
    • Edit loggingScheduler.properties in Notepad
    • Make the same change to this file
    • Restart the following services:
      • NuGenesis LMS Job Manager
      • NuGenesis LMS Job Scheduler
  • NuGenesis LMS Web Server
    1. Run the NuGenesis LMS Web server configuration tool.  Look on the desktop and the Start menu for "NuGenesis LMS IIS Configuration"
    2. Right-click on the shortcut and choose "Run as Administrator"
    3. Set the Log Level to DEBUG
    4. Click Next to skip past the other LMS Web server settings
    5. Click Finish to save the Web server configuration.
    6. Restart the NuGenesis LMS Web server
    7. The log file will be written to the path and file name as specified in the first page of the NuGenesis LMS IIS Configuration tool.
  • SampleShare
    • Run the LMS Sample Share configuration tool on the Start menu
    • Set the log level to DEBUG and click OK
    • The log file will be written to Drive:\inetpub\wwwroot\SampleShare\logs
  • NuGenesis Smart Builder
    1. Run the "Configure NuGenesis LMS Smart Builder" shortcut on the Start menu.
    2. Set the Log Level to DEBUG and click OK.
    3. If the LMS client is running, then close any open document sections and exit the client.  Re-start the client and re-open the Smart Builder section.
    4. The log file is named "LMSSmartBuilder-DATE.log" and it will be in the logged-in user's AppData folder: %APPDATA%\Waters\NuGenesis LMS Smart Builder.
  • Serial Device Support (SDS)
    1. Debug logging in SDS is controlled by a configuration file in the SDS installation folder.  If SDS is installed directly on users' PCs, then this folder will be on the users' PCs; or if the users access LMS through Citrix, then the installation folder will be on the Citrix servers.
    2. Browse to Drive:\Program Files (x86)\Waters\Waters Serial Device Support.
    3. Edit the file "sds.exe.config" in Notepad.
    4. Look for the XML tag "level".  Set it's value to "DEBUG".
      • Example:<level value="ERROR"/>
    5. Save and close the file.
    6. Restart the SDS software, or Excel if SDS is used through a Smart Builder form, for the logging changes to go into effect.
    7. The log file is named "Waters-SDS-DATE.log" and it will be in the logged-in user's AppData folder: %APPDATA%\Waters\Waters Serial Device Support.

ADDITIONAL INFORMATION

 

Not able to find a solution? Click here to request help.