Chapter 19: Difference between revisions

From RadiWiki
Jump to navigation Jump to search
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
= Appendices =
= Appendices =
==Appendix A: {{Radimation}} Support Procedure ==
==Appendix A: {{Radimation}} Support Procedure ==
===Definitions===
===Definitions===


Malfunctions are divided in eight categories and prioritized on their severity:
Malfunctions are divided in nine categories and prioritized on their severity:
# '''Incorrect Measurement:''' {{Radimation}} is performing a measurement (and it is not crashing), but the measured or shown data is incorrect.
* '''1 - Incorrect Measurement:''' {{Radimation}} software produces incorrect measurement results.
# '''Issue with Data Loss:''' Data has been lost due to a problem in {{RadiMation}}.
* '''2 - Issue with Data Loss:''' {{RadiMation}} software contains a problem that resulted in a situation that data is lost.
# '''Crash/Issue - No Data Loss:''' {{Radimation}} has aborted during operation (for no specific reason or known issue). After a restart, no data was lost.
* '''3 - Crash/Issue - No Data Loss:''' {{Radimation}} is aborted during operation without any specific reason or another issue occurred. After a restart, no data is lost.
# '''Mandatory New Functionality:''' {{RadiMation}} requires a functionality - that is currently not (completely) supported or implemented - to support a new standard or measurement. This includes the development of new device drivers.
* '''9 - Required device driver:''' A device driver for a measurement instrument must be created.
# '''Unexpected Functionality:''' Other possible cases of malfunction where the {{Radimation}} software is doing something differently then expected.  
* '''4 - Mandatory New Functionality:''' Functionality that is currently not implemented, but that is required to provide support for a new standard or measurement method.
# '''Cosmetic:''' Possible cosmetic malfunctions where {{Radimation}} 'in itself' is functioning correctly but the visual representation (in the form of screens, tables and or graphs) is not. For example when:
* '''5 - Unexpected Functionality:''' All other cases of malfunction of {{RadiMation}}, where the software functionality is responding differently than expected.
#* (Parts of) labels or information are not displayed.
* '''6 - Cosmetic:''' {{RadiMation}} software functions normal but the lay-out of the tables, graphs or screens are not represented in a proper way. For example when:
#* (Parts of) labels or information are overwritten by other labels or other information.
** (Parts of) labels or information are not displayed.
#* The screen 'flashes' while writing graphs or other information.
** (Parts of) labels or information are overwritten by other labels or other information.
#* The [[manual]] contains an error or unclear description.
** The screen 'flashes' while writing graphs or other information.
# '''Questions:''' An issue is not caused by a malfunction of {{RadiMation}}, but by the user's knowledge of {{RadiMation}}. A situation where the customer does not understand (part of) the functioning of {{RadiMation}} can be solved by informing the customer about the proper use of the software.  
** The [[manual]] contains an error or unclear description.
# '''Wish:''' There is no software malfunction or knowlegde issue. However the customer wishes (or even requires) {{Radimation}} to function in a different way, or contain additional functionalities, to support their use of the software. This can even mean the situation is unworkable for the customer, for example in situations where a certain functionality or part of a test is not supported.
* '''7 - Questions:''' End-user has a question about the operation of the {{RadiMation}} software.  
 
* '''8 - Wish:''' {{RadiMation}} software is missing specific functionality which should be evaluated for possible implementation in the future. In this category, there is not a real problem however the end-user requests {{RadiMation}} to function in a different way or requests additional functionality. This can even mean that the actual situation is unworkable for the end-user. This case encompasses situations where certain functionality or part of tests is not supported.
===Bug Reporting Procedure===


The goal of the 'Bug Reporting Procedure' is to support customers as quick and effective as possible.  
===Error report procedure===
The goal of the 'Error report procedure' is to support customers as quick and effective as possible.  


If you experience an issue with your {{RadiMation}} test software, or you simply have a request or question, please fill in the [http://www.dare.eu/instruments/emc-test-software/radimation-issue-report?|'''RadiMation Issue Report'''] on the DARE!! website.
{{:Error Report}}
 
Your issue will be addressed as soon as possible.


==Appendix B: Maintenance==
==Appendix B: Maintenance==
 
The service of solving 'bugs' in the software is covered by the maintenance contract. Depending on the situation it might be necessary for an engineer from {{CompanyName}} to supply on-site support. These costs are covered as well, excluding travel and lodging.
The service of solving 'bugs' in the software is covered by the maintenance contract. Depending on the situation it might be necessary for an engineer from DARE!! Instruments to supply on-site support. These costs are covered as well, excluding travel and lodging.
The service contract entitles the customer to all new push releases for the respective module(s).   
The service contract entitles the customer to all new push releases for the respective module(s).   


Functionality improvements and/or changes to the respective software module(s) that are desired by the customer (and are assessed by DARE!! as functional and commonly applicable), will be implemented in a future release of the software. It is important to keep in mind that improvements and/or changes for one customer shoud not lead to disadvantages for other customers.
Functionality improvements and/or changes to the respective software module(s) that are desired by the customer (and are assessed by {{CompanyName}} as functional and commonly applicable), will be implemented in a future release of the software. It is important to keep in mind that improvements and/or changes for one customer should not lead to disadvantages for other customers.


The {{RadiMation}} Support/Upgrade contract is mandatory and should be ordered with each {{RadiMation}} order.  
The {{RadiMation}} Support/Upgrade contract is mandatory and should be ordered with each {{RadiMation}} order.  
Line 37: Line 36:
* The first year is free of charge, each subsequent year costs 10% of the software order value.
* The first year is free of charge, each subsequent year costs 10% of the software order value.
* the starting date of the support/upgrade contract is the original delivery and/or installation date.
* the starting date of the support/upgrade contract is the original delivery and/or installation date.
* If a customer does not accept a support/upgrade contact, DARE!! Instruments will not provide any software support/upgrade service.
* If a customer does not accept a support/upgrade contact, {{CompanyName}} will not provide any software support/upgrade service.
 


===Releases===
===Releases===
Releases are divided in major and minor releases, indicated by a release number in the xxxx.yy.zz format. In this format, 'xxxx.yy' indicates the major release version. Where the 'xxxx' specifies in which year the software has been released. The '.yy' indicates if it is the first (.1) or second (.2) major release. The '.zz' specifies the minor release version.


Releases are divided in major and minor releases, indicated by a release number in the xx.yy.zz format. In this format, xx stands for the major release version and yy.zz for the minor release version.
{{RadiMation}} software releases can be downloaded from our website at: http://download.radimation.com/ .


Releases are shipped to the Reseller who is responsible for shipment and installation support at the customer.
The changes that are included in each version is available in the release notes of each version, that is available on or [[http://wiki.dare.nl/wiki/index.php/Category:Release_Notes  RadiWiki website ( http://wiki.radimation.com )]].


====Major release====
====Major release====
A major release consists of any and all new functionalities and bug fixes since the previous minor release. As such the major release is a base line release.  
A major release consists of any and all new functionalities and bug fixes since the previous minor release. As such the major release is a base line release.  
As a rule Major releases are push releases and are automatically send to all customers with a support contract.


====Minor release====
====Minor release====
A minor release is provided on top of the major release, to provide fixes for problems that has been found in the major releases. No new functionality will be added in these minor releases.


A minor release consists of a specific new functionality or bug fix(es). Where yy is the new functionality and zz the bugfix(es).
=== Release Planning ===
 
There will be two major releases of {{RadiMation}} each year. The planning of these two major releases is:
As a rule Minor releases are pull releases and are send to the customer(s) with a support contract that needs or request the release.
* 1st major: first week of April.
 
* 2nd major: first week of October.
 
===Release Planning===
 
There will be four main releases each year; two major/push releases and two minor/pull releases. Bug fix releases for specific customers are done in between.
 
The planning is as followed:
 
* 1st minor: The first Thursday after February 15h
* 1st major: The first Thursday after May 15th
* 2nd minor: The first Thursday after Augustus 15th
* 2nd major: The first Thursday after November 15th


[[Category:Manual]]
[[Category:Manual]]

Latest revision as of 14:30, 15 April 2019

Appendices[edit]

Appendix A: RadiMation® Support Procedure[edit]

Definitions[edit]

Malfunctions are divided in nine categories and prioritized on their severity:

  • 1 - Incorrect Measurement: RadiMation® software produces incorrect measurement results.
  • 2 - Issue with Data Loss: RadiMation® software contains a problem that resulted in a situation that data is lost.
  • 3 - Crash/Issue - No Data Loss: RadiMation® is aborted during operation without any specific reason or another issue occurred. After a restart, no data is lost.
  • 9 - Required device driver: A device driver for a measurement instrument must be created.
  • 4 - Mandatory New Functionality: Functionality that is currently not implemented, but that is required to provide support for a new standard or measurement method.
  • 5 - Unexpected Functionality: All other cases of malfunction of RadiMation®, where the software functionality is responding differently than expected.
  • 6 - Cosmetic: RadiMation® software functions normal but the lay-out of the tables, graphs or screens are not represented in a proper way. For example when:
    • (Parts of) labels or information are not displayed.
    • (Parts of) labels or information are overwritten by other labels or other information.
    • The screen 'flashes' while writing graphs or other information.
    • The manual contains an error or unclear description.
  • 7 - Questions: End-user has a question about the operation of the RadiMation® software.
  • 8 - Wish: RadiMation® software is missing specific functionality which should be evaluated for possible implementation in the future. In this category, there is not a real problem however the end-user requests RadiMation® to function in a different way or requests additional functionality. This can even mean that the actual situation is unworkable for the end-user. This case encompasses situations where certain functionality or part of tests is not supported.

Error report procedure[edit]

The goal of the 'Error report procedure' is to support customers as quick and effective as possible.

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[edit]

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[edit]

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.svg Help
      Menu.svg 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[edit]

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[edit]

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 250 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.

Appendix B: Maintenance[edit]

The service of solving 'bugs' in the software is covered by the maintenance contract. Depending on the situation it might be necessary for an engineer from Raditeq to supply on-site support. These costs are covered as well, excluding travel and lodging. The service contract entitles the customer to all new push releases for the respective module(s).

Functionality improvements and/or changes to the respective software module(s) that are desired by the customer (and are assessed by Raditeq as functional and commonly applicable), will be implemented in a future release of the software. It is important to keep in mind that improvements and/or changes for one customer should not lead to disadvantages for other customers.

The RadiMation® Support/Upgrade contract is mandatory and should be ordered with each RadiMation® order.

  • The minimum duration of this contract is 2 years.
  • The first year is free of charge, each subsequent year costs 10% of the software order value.
  • the starting date of the support/upgrade contract is the original delivery and/or installation date.
  • If a customer does not accept a support/upgrade contact, Raditeq will not provide any software support/upgrade service.

Releases[edit]

Releases are divided in major and minor releases, indicated by a release number in the xxxx.yy.zz format. In this format, 'xxxx.yy' indicates the major release version. Where the 'xxxx' specifies in which year the software has been released. The '.yy' indicates if it is the first (.1) or second (.2) major release. The '.zz' specifies the minor release version.

RadiMation® software releases can be downloaded from our website at: http://download.radimation.com/ .

The changes that are included in each version is available in the release notes of each version, that is available on or [RadiWiki website ( http://wiki.radimation.com )].

Major release[edit]

A major release consists of any and all new functionalities and bug fixes since the previous minor release. As such the major release is a base line release.

Minor release[edit]

A minor release is provided on top of the major release, to provide fixes for problems that has been found in the major releases. No new functionality will be added in these minor releases.

Release Planning[edit]

There will be two major releases of RadiMation® each year. The planning of these two major releases is:

  • 1st major: first week of April.
  • 2nd major: first week of October.

Multiband: Tests that allow more flexible test configurations, where multiple bands with different settings can be specified in a single TSF.

Megabyte: 1 million bytes.

Retrieved from "https://wiki.radimation.com/wiki/index.php?title=Chapter_19&oldid=18871"