User:Jcreer/SMS:Bug Trace: Difference between revisions
From XMS Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
When SMS appears to have bug, performing a trace can help the developers isolate the cause. Having a bug trace report significantly increase the speed in which issues with the software can be resolved. | When SMS appears to have bug, performing a trace can help the developers isolate the cause. Having a bug trace report significantly increase the speed in which issues with the software can be resolved. A bug trace report will on help with issues where SMS is crashing or hanging. It will not help with issues related to invalid inputs, invalid model results, or similar issues. | ||
To perform a bug trace, the following files are needed: | To perform a bug trace, the following files are needed: | ||
* smsTrace122.exe | * smsTrace***.exe – This file will contain a number in the file to match the version of the software such as "smsTrace122.exe" or "smsTrace 123.exe". | ||
* trace_configure.bat | * trace_configure.bat | ||
* trace_clear.bat | * trace_clear.bat | ||
Perform a bug trace by doing the following: | Perform a bug trace by doing the following: | ||
# Run the trace_configure.bat file. | # Run the "trace_configure.bat" file. | ||
#: This will create two files (debug_xms_trace.dbg and debug_xms_log.dbg) in the C:\temp\ directory | #: This will create two files ("debug_xms_trace.dbg" and "debug_xms_log.dbg") in the "C:\temp\" directory. If there is already a file called "DebugLog.txt" in the temp directory, it will be deleted during this process. | ||
# | # Copy the "smsTrace***.exe" file to the where SMS is located on the machine. | ||
# Run the | #: For exmple, smsTrace123.exe would be copied to "C:\Program Files\SMS 12.3 64-bit" if this is the directory where SMS 12.3 has been installed. | ||
# Execute the SMS function that causes | # Run the "smsTrace***.exe" until finished tracing. | ||
#: This should | # Execute the SMS function that causes the issue. | ||
# Return the C:\temp\DebugLog.txt to Aquaveo | #: This should be an issue that causes SMS to crash or hang. | ||
#: This file contains the trace and may be viewed in an editor. | # Return the "C:\temp\DebugLog.txt" to Aquaveo technical support. | ||
# Run the trace_clear.bat | #: This file contains the trace and may be viewed in an editor. Aquaveo technical support can be reached at: support@aquaveo.com | ||
#: This will remove the debug_xms_*.dbg files. | # Run the "trace_clear.bat" file. | ||
#: This will remove the "debug_xms_*.dbg" files. | |||
Once Aquaveo developers have the DebugLog.txt file, they will begin working on a solution. Be advised that solutions to bugs typically take 1–2 months to be resolved and may take much longer depending on the issue. | Once Aquaveo developers have the DebugLog.txt file, they will begin working on a solution. Be advised that solutions to bugs typically take 1–2 months to be resolved and may take much longer depending on the issue. | ||
[[Category:Support]] | [[Category:Support]] | ||
Revision as of 15:24, 13 June 2018
When SMS appears to have bug, performing a trace can help the developers isolate the cause. Having a bug trace report significantly increase the speed in which issues with the software can be resolved. A bug trace report will on help with issues where SMS is crashing or hanging. It will not help with issues related to invalid inputs, invalid model results, or similar issues.
To perform a bug trace, the following files are needed:
- smsTrace***.exe – This file will contain a number in the file to match the version of the software such as "smsTrace122.exe" or "smsTrace 123.exe".
- trace_configure.bat
- trace_clear.bat
Perform a bug trace by doing the following:
- Run the "trace_configure.bat" file.
- This will create two files ("debug_xms_trace.dbg" and "debug_xms_log.dbg") in the "C:\temp\" directory. If there is already a file called "DebugLog.txt" in the temp directory, it will be deleted during this process.
- Copy the "smsTrace***.exe" file to the where SMS is located on the machine.
- For exmple, smsTrace123.exe would be copied to "C:\Program Files\SMS 12.3 64-bit" if this is the directory where SMS 12.3 has been installed.
- Run the "smsTrace***.exe" until finished tracing.
- Execute the SMS function that causes the issue.
- This should be an issue that causes SMS to crash or hang.
- Return the "C:\temp\DebugLog.txt" to Aquaveo technical support.
- This file contains the trace and may be viewed in an editor. Aquaveo technical support can be reached at: support@aquaveo.com
- Run the "trace_clear.bat" file.
- This will remove the "debug_xms_*.dbg" files.
Once Aquaveo developers have the DebugLog.txt file, they will begin working on a solution. Be advised that solutions to bugs typically take 1–2 months to be resolved and may take much longer depending on the issue.
