Difference between revisions of "Error Report"

From RadiWiki
Jump to: navigation, search
(Reporting a RadiLog communication file only)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
An issue could be a bug or something that is not working correctly, or working differently then expected. The goal of the error report procedure is to accomplish quick and effective support service. In general, a new problem (or issue) can only be solved if our {{RadiMation}} support team will be able to reproduce the problem. The issue report procedure is intended to store and provide all relevant information that is needed to investigate and reproduce the issue.
+
<!-- Be aware that this page is also included in the manual. That is why the sections start with 3x = !! -->An issue could be a bug or something that is not working correctly, or working differently then expected. The goal of the error report procedure is to accomplish quick and effective support service. In general, a new problem (or issue) can only be solved if our {{RadiMation}} support team will be able to reproduce the problem. The issue report procedure is intended to store and provide all relevant information that is needed to investigate and reproduce the issue.
  
{{RadiMation}} incorporates the {{RadiLog}} automatic logging tool which is automatically running in background and captures all communication. In case of a problematic event, all relevant information can be transferred to the {{RadiMation}} support team by pressing the {{ScreenElement|Report}} button when there is an error. This form can also be [[#Manually reporting an issue|accessed manually]]. It is of course also possible to send us any question by e-mailing us at {{MailSupport}}.
+
{{RadiMation}} incorporates the {{RadiLog}} automatic logging tool which is automatically running in background and captures all communication. In case of a problematic event, all relevant information can be transferred to the {{RadiMation}} support team by pressing the {{ScreenElement|Report}} button when there is an error. This form can also be [[#Manually reporting an issue|accessed manually]]. It is of course also possible to send us any question directly by e-mailing us at {{MailSupport}}.
  
Upon receipt of a new reported issue the {{RadiMation}} support team will provide a unique issue number (#xxxxx). This reference number should be used during all further communication in relation to the specific issue.  
+
Upon receipt of a new reported issue the {{RadiMation}} support team will provide a unique ticket number (#xxxxx). This ticket number should be used during all further communication in relation to the specific ticket.  
  
=== Reporting a problem when an Error is shown ===
+
=== Reporting a problem when an error is shown ===
 
When an error is shown within {{RadiMation}}, the error can be directly reported to the [[RadiMation|{{RadiMation}}]] support team.
 
When an error is shown within {{RadiMation}}, the error can be directly reported to the [[RadiMation|{{RadiMation}}]] support team.
  
 
# On the [[RadiMation|{{RadiMation}}]] Error Window, press the {{ScreenElement|Report}} button.<BR />[[File:ErrorPopupWindow.png]]
 
# On the [[RadiMation|{{RadiMation}}]] Error Window, press the {{ScreenElement|Report}} button.<BR />[[File:ErrorPopupWindow.png]]
 
# The {{ScreenElement|Error Report}} window will be shown.<BR />[[File:ReportErrorWindow.png]]
 
# The {{ScreenElement|Error Report}} window will be shown.<BR />[[File:ReportErrorWindow.png]]
# Fill in all the additional information like requested. As seen in the screenshot, you must check the {{ScreenElement|I agree that my provided data is used to improve the products and services of DARE!!}} checkbox.
+
# Specify your own contact details, so we know how to contact you for a solution. As seen in the screenshot, you also must check the {{ScreenElement|I agree that my provided data is used to improve the products and services of Raditeq}} checkbox.
# Check if you have filled all boxes. If not all boxes are filled you can not send or save the file. When information is missing a red circle with a cross is displayed. If you hover over it with your mouse it will tell you what is missing in the form.  
+
# Ensure that all the fields do contain the correct information. If not all fields are filled you can not send or save the file. When information is missing, a red circle with a cross is displayed. If you hover over it with your mouse it will inform you what is missing in the form.  
 
# Once the report information is filled in the buttons change colour, the report can now be send to the {{RadiMation}} support team in 2 ways:
 
# Once the report information is filled in the buttons change colour, the report can now be send to the {{RadiMation}} support team in 2 ways:
#* Send the report automatically using the {{ScreenElement|Send}} button.
+
#* Send the report automatically using the {{ScreenElement|Send}} button. A message will be shown that the error report is transmitted. You also will receive almost directly an e-mail from our ticket database with the ticket number that has been created for your error report.
 
#* Save the report with the {{ScreenElement|Save}} button, and send the file over email to {{MailSupport}}
 
#* Save the report with the {{ScreenElement|Save}} button, and send the file over email to {{MailSupport}}
  
Line 21: Line 21:
  
 
If you would like to report a problem with {{RadiMation}} without a {{RadiMation}} error, you can also open the Error Report window from the Help menu:
 
If you would like to report a problem with {{RadiMation}} without a {{RadiMation}} error, you can also open the Error Report window from the Help menu:
{{Menu|Help|Report Error}}.
+
{{Menu|Help|Report}}.
  
 
[[File:ManualReportMenu.png]]
 
[[File:ManualReportMenu.png]]
Line 27: Line 27:
 
Also if a test is already running, and you would like to report an error related to the running test, but no Error Report window is shown, then it is still possible to use this Help menu. The generated Error Report will then still contain the communication log of the running test.
 
Also if a test is already running, and you would like to report an error related to the running test, but no Error Report window is shown, then it is still possible to use this Help menu. The generated Error Report will then still contain the communication log of the running test.
  
=== Reporting a RadiLog communication file only ===
+
=== Reporting a {{RadiLog}} communication file only ===
  
If for some reason the above reporting is not available, the hardware communication log can also be reported manually.
+
If for some reason the above reporting is not available, the communication log can also be reported manually.
 
Please follow these instructions accordingly:
 
Please follow these instructions accordingly:
# Open the Radimation logging tool from the View menu in RadiMation <BR />[[File:ViewRadiLogMenu.png]]
+
# Open the {{RadiMation}} logging tool ({{RadiLog}}) from the View menu in {{RadiMation}} <BR />[[File:ViewRadiLogMenu.png]]
# While the tool is opened, reproduce the error.
+
# While the {{RadiLog}} tool is opened, reproduce the error.
# When the error has been logged, save the log file. <BR />[[File:RadiLogSaveAs.png]]
+
# When the error has been logged, save the log file, by selecting 'File' and 'Save As...' from the menu.<BR />[[File:RadiLogSaveAs.png]]
# Send the .RadiLog file (zipped) to the RadiMation support e-mail address {{MailSupport}}
+
# Send the .RadiLog file (zipped) to the {{RadiMation}} support e-mail address {{MailSupport}}
 +
 
 +
=== Sending larger files ===
 +
It sometimes is required to send larger or additional files to the {{RadiMation}} support team, however the general limitation for sending files by e-mail is limited to 6 MB files.
 +
 
 +
The [[Error Report]] functionality is able to include larger files (in total up to 100 MB). On the {{ScreenElement|Files}} tab, a list of all the files that are contained in the [[Error Report]] is being shown.
 +
 
 +
[[File:ErrorReportFilesTab.png]]
 +
 
 +
Only the files that have a checked checkbox will be included in the transmission.
 +
 
 +
If one or more additional files should be transmitted to us, it is advised to create a ZIP file which contains all the files that should be included. Then that ZIP file can be drag-and-dropped from a Microsoft Windows Explorer window onto the list of files in the Error Report. The ZIP file will then be added and included in the Error Report that will be transmitted to us.
 +
In the example screenshot above, this has been done with the file 'Additional files.zip'.
 +
 
 +
The total size of all the files in the ErrorReport can be recalculated by clicking on the {{ScreenElement|Report Size}} button.
  
 
[[Category:Support]]
 
[[Category:Support]]
 
[[Category:RadiMation]]
 
[[Category:RadiMation]]
 +
[[Category:Manual]]

Latest revision as of 13:41, 27 July 2022

An issue could be a bug or something that is not working correctly, or working differently then expected. The goal of the error report procedure is to accomplish quick and effective support service. In general, a new problem (or issue) can only be solved if our RadiMation® support team will be able to reproduce the problem. The issue report procedure is intended to store and provide all relevant information that is needed to investigate and reproduce the issue.

RadiMation® incorporates the RadiLog automatic logging tool which is automatically running in background and captures all communication. In case of a problematic event, all relevant information can be transferred to the RadiMation® support team by pressing the Report button when there is an error. This form can also be accessed manually. It is of course also possible to send us any question directly by e-mailing us at radimation-support@raditeq.com.

Upon receipt of a new reported issue the RadiMation® support team will provide a unique ticket number (#xxxxx). This ticket number should be used during all further communication in relation to the specific ticket.

Reporting a problem when an error is shown

When an error is shown within RadiMation®, the error can be directly reported to the RadiMation® support team.

  1. On the RadiMation® Error Window, press the Report button.
    ErrorPopupWindow.png
  2. The Error Report window will be shown.
    ReportErrorWindow.png
  3. Specify your own contact details, so we know how to contact you for a solution. As seen in the screenshot, you also must check the I agree that my provided data is used to improve the products and services of Raditeq checkbox.
  4. Ensure that all the fields do contain the correct information. If not all fields are filled you can not send or save the file. When information is missing, a red circle with a cross is displayed. If you hover over it with your mouse it will inform you what is missing in the form.
  5. Once the report information is filled in the buttons change colour, the report can now be send to the RadiMation® support team in 2 ways:
    • Send the report automatically using the Send button. A message will be shown that the error report is transmitted. You also will receive almost directly an e-mail from our ticket database with the ticket number that has been created for your error report.
    • Save the report with the Save button, and send the file over email to radimation-support@raditeq.com

The report automatically contains a log of all the recent communication with the test and measurement equipment. That information is very helpful and valuable to be able to resolve your issue.

Manually reporting an issue

If you would like to report a problem with RadiMation® without a RadiMation® error, you can also open the Error Report window from the Help menu:

   Menu.png Help
      Menu.png Report .

ManualReportMenu.png

Also if a test is already running, and you would like to report an error related to the running test, but no Error Report window is shown, then it is still possible to use this Help menu. The generated Error Report will then still contain the communication log of the running test.

Reporting a RadiLog communication file only

If for some reason the above reporting is not available, the communication log can also be reported manually. Please follow these instructions accordingly:

  1. Open the RadiMation® logging tool (RadiLog) from the View menu in RadiMation®
    ViewRadiLogMenu.png
  2. While the RadiLog tool is opened, reproduce the error.
  3. When the error has been logged, save the log file, by selecting 'File' and 'Save As...' from the menu.
    RadiLogSaveAs.png
  4. Send the .RadiLog file (zipped) to the RadiMation® support e-mail address radimation-support@raditeq.com

Sending larger files

It sometimes is required to send larger or additional files to the RadiMation® support team, however the general limitation for sending files by e-mail is limited to 6 MB files.

The Error Report functionality is able to include larger files (in total up to 100 MB). On the Files tab, a list of all the files that are contained in the Error Report is being shown.

ErrorReportFilesTab.png

Only the files that have a checked checkbox will be included in the transmission.

If one or more additional files should be transmitted to us, it is advised to create a ZIP file which contains all the files that should be included. Then that ZIP file can be drag-and-dropped from a Microsoft Windows Explorer window onto the list of files in the Error Report. The ZIP file will then be added and included in the Error Report that will be transmitted to us. In the example screenshot above, this has been done with the file 'Additional files.zip'.

The total size of all the files in the ErrorReport can be recalculated by clicking on the Report Size button.