How to enable debug logging in NuGenesis LMS - WKB16442
Article number: 16442
OBJECTIVE or GOAL
Enable debug logging in NuGenesis LMS software, in order to provide detailed information to Waters Support regarding a technical issue with LMS.
ENVIRONMENT
- NuGenesis 9 LMS
- NuGenesis 8 LMS
PROCEDURE
Debug logging in NuGenesis LMS is controlled separately within each component:
- NuGenesis LMS clients
- 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, this folder will be on the users' PCs; if the users access LMS through Citrix, the installation folder will be on the Citrix servers.
- Look for the "eln.exe.config" file within the LMS client installation folder. Open this file in Notepad.
- Look for the XML tag "<priority". Set its value to "DEBUG". The default value is "ERROR".
- Example: <priority value="ERROR"></priority>
- Restart the LMS client if it is running.
- 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, 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
- For 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
- For NuGenesis 8 FR1/SR2 and NuGenesis 9, create the path C:\tmp on the LMS client machines. The image writer will write to a log file in C:\tmp.
- For NuGenesis 8 SR1, create the following registry keys:
- 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:
- Edit the following file in Notepad:
- Drive:\Program Files (x86)\Waters\LMS Empower Interface\EmpowerSampleBrowser.exe.config
- Change <priority value = "ERROR"/> to <priority value="DEBUG"/>.
- Save and close the file.
- Close and reopen the Sample Browser if it is open.
- Edit the following file in Notepad:
- Result Sender:
- Edit the following file in Notepad:
- Drive:\Program Files (x86)\Waters\LMS Empower Interface\EmpowerResultsSender.exe.config
- Change <priority value = "ERROR"/> to <priority value="DEBUG"/>
- Save and close the file
- Close and reopen the Result Sender if it is open
- Edit the following file in Notepad:
- The log files will be written to C:\ProgramData\Waters\LMS Empower Interface\Log
- NuGenesis LMS Server (JBOSS/WildFly)
- Run the NuGenesis LMS Server configuration tool. Look on the desktop and in the Start menu for shortcuts to this tool
- Click the Logs entry in the configuration tool
- Set the "Default log level" to DEBUG
- To set the log level for a specific category, set the log level
- Click Apply and Close
- Restart the NuGenesis LMS Server service for the change to take effect
- The log files will be written to Drive:\WatersLMSServer\log
- externSQLQueries.log: com.creon.externaldbtoolkit
- server.log: all other categories
- ConnectionManager.log: org.jboss.jca
- eventConsumer.log: com.creon.eln.ELN_ProcExec
- NuGenesis LMS Job Services
- Edit the following file in Notepad:
- Drive:\WatersLMSServer\actback\properties\com\creon\qdisr\properties\loggingManager.properties
- Change the setting of "log4j.rootCategory" from "ERROR,ROOT" to "DEBUG,ROOT"
- Save and close loggingManager.properties
- Edit the following file in Notepad:
- Drive:\WatersLMSServer\actback\properties\com\creon\qdisr\properties\loggingScheduler.properties
- set log4j.rootCategory to DEBUG,ROOT
- Save and close loggingScheduler.properties
- Restart the following services:
- NuGenesis LMS Job Manager
- NuGenesis LMS Job Scheduler
- Edit the following file in Notepad:
- NuGenesis LMS Web Server
- Run the NuGenesis LMS Web server configuration tool. Look on the desktop and in the Start menu for "NuGenesis LMS IIS Configuration".
- Right-click on the shortcut and choose "Run as Administrator".
- Set the Log Level to DEBUG.
- Click Next to skip past the other LMS Web server settings.
- Click Finish to save the Web server configuration.
- Restart the NuGenesis LMS Web server.
- 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
- WatersLMS PDF Printer (Amyuni Document Converter)
- Create the following registry key on the LMS web server:
- HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Hardware Profiles\0001\Software\WatersLMS PDF Printer, Name: TraceEnabled, Type: DWORD, Value: 1
- When a user next opens a document report in LMS, the printer will write to a log file, C:\temp\pdfdrv.log, on the LMS Web server
- To write the log file to a different folder or file name, create the following key:
- HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Hardware Profiles\0001\Software\WatersLMS PDF Printer, Name: TraceFile, Type: REG_SZ, Value: <full path to log file>
- More options for the PDF converter trace logging can be found on Amyuni's website
- Create the following registry key on the LMS web server:
- SampleShare
- Run the LMS Sample Share configuration tool from 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
- Run the "Configure NuGenesis LMS Smart Builder" shortcut from the Start menu.
- Set the Log Level to DEBUG and click OK.
- If the LMS client is running, close any open document sections and exit the client. Restart the client and reopen the Smart Builder section.
- 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)
- Debug logging in SDS is controlled by a configuration file in the SDS installation folder. If SDS is installed directly on users' PCs, this folder will be on the users' PCs; if users access LMS through Citrix, the installation folder will be on the Citrix servers.
- Browse to Drive:\Program Files (x86)\Waters\Waters Serial Device Support.
- Edit the file "sds.exe.config" in Notepad.
- Look for the XML tag "level". Set its value to "DEBUG".
- Example: <level value="ERROR"/>
- Save and close the file.
- Restart the SDS software (or Excel if SDS is used through a Smart Builder form) for the logging changes to take effect.
- 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
id16442, ELN, MSDS, NGLMS, NGLMSLIC, NGLMSOPT, SUPNG