SMS:Report Bug: Difference between revisions
From XMS Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| (20 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOINDEX__ | |||
{{SMS Deprecated Feature}} | |||
[[File:ReportBug.jpg|thumb|300 px|Example of the ''Report Bug'' dialog.]] | [[File:ReportBug.jpg|thumb|300 px|Example of the ''Report Bug'' dialog.]] | ||
While Aquaveo and its developers work hard to keep problems in SMS to a minimum, some bugs or defects may occasionally surface. Reporting bugs helps Aquaveo and its developers resolve these issues. SMS must be connected to the internet in order to report a bug. | While Aquaveo and its developers work hard to keep problems in SMS to a minimum, some bugs or defects may occasionally surface. Reporting bugs helps Aquaveo and its developers resolve these issues. SMS must be connected to the internet in order to report a bug. | ||
| Line 4: | Line 6: | ||
Some bugs in SMS are reported automatically to Aquaveo. This is done through bug trap software included in SMS. Automatic bug reports typically happen whenever SMS crashes. | Some bugs in SMS are reported automatically to Aquaveo. This is done through bug trap software included in SMS. Automatic bug reports typically happen whenever SMS crashes. | ||
Bugs can also be reported | Bugs can also be reported. It is advisable to first check [[SMS:Release Notes SMS|Bugfixes SMS]] and the Aquaveo [http://forum.aquaveo.com/ Support Forums] to see if the bug has already been reported. To report a new bug, go to the [[SMS:Help Menu|''Help'']] menu and select the '''Report Bug''' command. Activating this command will bring up the ''Report Bug'' dialog. | ||
==Report Bug Dialog== | ==Report Bug Dialog== | ||
When reporting a bug, | When reporting a bug, complete as many of the sections of the ''Report Bug'' dialog as possible. The more information the developers have the more likely the situation can be resolved in a timely manner. | ||
*''System Information'' | *''System Information'' | ||
*''What I did'' | *:SMS will deliver a text file that gives the configuration of SMS on the computer where the bug was reported. Clicking on the '''View''' button will bring up this text file showing what information is being sent. | ||
*''What the result was'' | *''What I did'' | ||
*''What the expected result was'' | *:Write in this section a brief description of the actions that were being done when the bug occurred. | ||
*''Email address'' | *''What the result was'' | ||
*''Project files'' | *:In this section, briefly explain the evidence of the bug in SMS. | ||
*''What the expected result was'' | |||
*:It is best to not assume that the developers will understand what should have appeared instead of the bug. Briefly state what should have occurred had the bug not occurred. | |||
*''Email address'' | |||
*:Provide an email address so that Aquaveo can follow up on the reported bug. Emails in bug reports are kept private and are not sold or used in marketing. | |||
*''Project files'' | |||
*: It can be helpful to include project files of the project being worked on when the bug occurred. This will help determine if the bug is related to SMS or if it is a problem with the project files. Include all files in a single ZIP file. Use the browser button [[File:Generic Folder.svg|15 px]] to attach the ZIP file to the bug report. | |||
After completing this dialog, pressing '''OK''' will send the information to Aquaveo, LLC. An internet connection must be available and active for this information to be received. | After completing this dialog, pressing '''OK''' will send the information to Aquaveo, LLC. An internet connection must be available and active for this information to be received. | ||
| Line 22: | Line 30: | ||
In some cases, a bug cannot be resolved by Aquaveo, this is particularly true in cases where the bug has been caused by user error or if the bug is caused by third-party software used by SMS. | In some cases, a bug cannot be resolved by Aquaveo, this is particularly true in cases where the bug has been caused by user error or if the bug is caused by third-party software used by SMS. | ||
Not all users will be contacted once a bug is resolved. It is recommended | Not all users will be contacted once a bug is resolved. It is recommended to contact Aquaveo's [[SMS:Support|technical support]] if there are further concerns. | ||
==Related Topics== | ==Related Topics== | ||
* [[SMS: | * [[SMS:Release Notes SMS|Bugfixes SMS]] | ||
* [[SMS:Support|Support]] | * [[SMS:Support|Support]] | ||
| Line 32: | Line 40: | ||
[[Category:SMS General Information]] | [[Category:SMS General Information]] | ||
[[Category:SMS Dialogs]] | [[Category:SMS Dialogs]] | ||
[[Category:External Links]] | |||
[[Category:Support]] | |||
[[Category:Archived]] | |||
Latest revision as of 20:17, 9 January 2023
 |
This contains information about features no longer in use for the current release of SMS. The content may not apply to current versions. |
 |
While Aquaveo and its developers work hard to keep problems in SMS to a minimum, some bugs or defects may occasionally surface. Reporting bugs helps Aquaveo and its developers resolve these issues. SMS must be connected to the internet in order to report a bug.
Some bugs in SMS are reported automatically to Aquaveo. This is done through bug trap software included in SMS. Automatic bug reports typically happen whenever SMS crashes.
Bugs can also be reported. It is advisable to first check Bugfixes SMS and the Aquaveo Support Forums to see if the bug has already been reported. To report a new bug, go to the Help menu and select the Report Bug command. Activating this command will bring up the Report Bug dialog.
Report Bug Dialog
When reporting a bug, complete as many of the sections of the Report Bug dialog as possible. The more information the developers have the more likely the situation can be resolved in a timely manner.
- System Information
- SMS will deliver a text file that gives the configuration of SMS on the computer where the bug was reported. Clicking on the View button will bring up this text file showing what information is being sent.
- What I did
- Write in this section a brief description of the actions that were being done when the bug occurred.
- What the result was
- In this section, briefly explain the evidence of the bug in SMS.
- What the expected result was
- It is best to not assume that the developers will understand what should have appeared instead of the bug. Briefly state what should have occurred had the bug not occurred.
- Email address
- Provide an email address so that Aquaveo can follow up on the reported bug. Emails in bug reports are kept private and are not sold or used in marketing.
- Project files
- It can be helpful to include project files of the project being worked on when the bug occurred. This will help determine if the bug is related to SMS or if it is a problem with the project files. Include all files in a single ZIP file. Use the browser button
to attach the ZIP file to the bug report.
- It can be helpful to include project files of the project being worked on when the bug occurred. This will help determine if the bug is related to SMS or if it is a problem with the project files. Include all files in a single ZIP file. Use the browser button
After completing this dialog, pressing OK will send the information to Aquaveo, LLC. An internet connection must be available and active for this information to be received.
After Submitting a Bug
After a bug has been submitted, Aquaveo will review the reported bug. Whenever possible, the bug will be resolved as quickly as possible. There is no time frame for when a bug will be resolved—some are resolved within hours while others may not be resolved for many months.
In some cases, a bug cannot be resolved by Aquaveo, this is particularly true in cases where the bug has been caused by user error or if the bug is caused by third-party software used by SMS.
Not all users will be contacted once a bug is resolved. It is recommended to contact Aquaveo's technical support if there are further concerns.
Related Topics
SMS – Surface-water Modeling System | ||
|---|---|---|
| Modules: | 1D Grid • Cartesian Grid • Curvilinear Grid • GIS • Map • Mesh • Particle • Quadtree • Raster • Scatter • UGrid | |
| General Models: | 3D Structure • FVCOM • Generic • PTM | |
| Coastal Models: | ADCIRC • BOUSS-2D • CGWAVE • CMS-Flow • CMS-Wave • GenCade • STWAVE • WAM | |
| Riverine/Estuarine Models: | AdH • HEC-RAS • HYDRO AS-2D • RMA2 • RMA4 • SRH-2D • TUFLOW • TUFLOW FV | |
| Aquaveo • SMS Tutorials • SMS Workflows | ||
