Difference between revisions of "Technical Support"

From MIPAV
Jump to: navigation, search
(MIPAV Options dialog box - the Other tab)
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<div style="font-style: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 24pt; text-align: right; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">'''<font color="#000000"> 4 <br /></font>'''</div><div style="font-style: normal; margin-bottom: 600pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: right; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">'''<font color="#000000">  Technical support<br /></font>'''</div><div style="font-style: normal; margin-bottom: 6pt; margin-left: 6pt; margin-right: 6pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">'''<font color="#0023a9"> In this chapter . . .<br /></font>'''</div><div style="font-style: normal; font-weight: normal; margin-bottom: 1pt; margin-left: 18pt; margin-right: 6pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: -12pt; text-transform: none; vertical-align: baseline"><font color="#0023a9"> "Placing MIPAV in debug mode" <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 1pt; margin-left: 18pt; margin-right: 6pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: -12pt; text-transform: none; vertical-align: baseline"><font color="#0023a9"> "Gather software information" <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 1pt; margin-left: 18pt; margin-right: 6pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: -12pt; text-transform: none; vertical-align: baseline"><font color="#0023a9"> "Contact MIPAV technical support" <br /></font></div><div style="font-style: normal; margin-bottom: 0pt; margin-left: 6pt; margin-right: 6pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">'''<font color="#0023a9"> <br /></font>'''</div>
+
== Troubleshooting MIPAV==
 +
If a problem occurs while you are using MIPAV, please contact us so that it can be addressed in a future release of the software. Please perform the following steps so that we have the correct information needed to resolve your problem:
  
== Troubleshooting ==
+
<ol>
 
+
<li>[[#DebugMode | Place MIPAV in debug mode]]</li>
<div style="font-weight: normal; margin-bottom: 6pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">''<font color="#000000"> If a problem occurs while you are using MIPAV, please contact us so that it can be addressed in a future release of the software. Please perform the following steps so that we have the correct information needed to resolve your problem:<br /></font>''</div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000">  1 Place MIPAV in debug mode,<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000">  2 Gather software information,<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000">  3 Contact technical support.<br /></font></div>
+
<li>[[#GatherInformation | Gather software information]]</li>
 +
<li>[[#ContactSupport | Contact technical support]]</li>
 +
</ol>
  
 +
<div id="DebugMode"></div>
 
=== Placing MIPAV in debug mode ===
 
=== Placing MIPAV in debug mode ===
 +
[[File:MipavOptionsOtherDebugLevels.jpg|400px|thumb|left|Debug mode]]
  
<div style="font-style: normal; font-weight: normal; margin-bottom: 6pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> When you place MIPAV in debug mode, MIPAV creates a log of the software error messages that occur when MIPAV is being used. You can view these messages to pinpoint problems or you can save a copy to use as a reference when you contact technical support.<br /></font></div>
+
When you place MIPAV in debug mode, MIPAV creates a log of the software error messages that occur when MIPAV is being used. You can view these messages to pinpoint problems or you can save a copy to use as a reference when you contact technical support.<br />
  
 
==== To turn debug mode on ====
 
==== To turn debug mode on ====
 +
<ol>
 +
<li>Select Help &gt; Program Options. The MIPAV Options dialog box opens.</li>
 +
<li> Open the Other tab.</li>
 +
<li> Check the '''Show Data/Debugging Output Window''' check box. Then select the debugging level. The five debugging levels - from Minor to Scripting -correlate to the amount of debugging information provided on the Debug page and the amount of computer memory used. The '''Minor''' level provides the least amount of debugging information, and the '''Scripting''' level provides the highest level of the debugging information.</li>
 +
<li> Click Apply, then Click Close. From this point on, MIPAV places debugging data on the Debug page in the Output window. If software errors have occurred, messages appear in the Debug window.</li>
 +
<li> Save the debug information:</li>
 +
<ul>
 +
<li>To save the debug information to a file, select File &gt; Save Messages. The Save dialog box opens. Type a name for the file in File Name, and then click Save.</li>
 +
<li>To copy the information to the clipboard, select Edit &gt; Copy. You can then paste the information in any text editing, word processing, desktop publishing, or e-mail program of your choice.</li>
 +
</ul>
 +
</ol>
  
<div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000">  1 Select Help &gt; Program Options. The MIPAV Options dialog box opens. <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000">  2 Open the Other tab. See [MIPAVTroubleShooting.html#1337843 Figure 1].<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000">  3 Check the <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Show Data/Debugging Output Window</font>'''</span> check box. Then select the debugging level. The five debugging levels - from Minor to Scripting -correlate to the amount of debugging information provided on the Debug page and the amount of computer memory used. The <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Minor</font>'''</span> level provides the least amount of debugging information, and the <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Scripting</font>'''</span> level provides the highest level of the debugging information. See Figure 1.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000">  4 Click Apply, then Click Close. From this point on, MIPAV places debugging data on the Debug page in the Output window. If software errors have occurred, messages appear in the Debug window. See Figure 1<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000">  5 Save the debug information:<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 36pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -12pt; text-transform: none; vertical-align: baseline"><font color="#000000">  To save the debug information to a file, select File &gt; Save Messages. The Save dialog box opens. Type a name for the file in File Name, and then click Save.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 36pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -12pt; text-transform: none; vertical-align: baseline"><font color="#000000">  To copy the information to the clipboard, select Edit &gt; Copy. You can then paste the information in any text editing, word processing, desktop publishing, or e-mail program of your choice.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 5pt; margin-left: 0pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Note:</font>'''</span> If you are running MIPAV on a Windows platform, before you place MIPAV in debug mode, it is helpful to exit from the program and then restart it again by holding the Crtl key while you select Start &gt; MIPAV. A DOS window opens on your desktop behind the MIPAV application windows.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 5pt; margin-left: 0pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Note:</font>'''</span> If you've contacted MIPAV developers about a problem with the program, they may ask you to save the debugging data in a text file. To do this, you would mark Redirect errors to file and type the name of the file in the box beside the check box. You can then send the file to them via e-mail.<br /></font></div>
+
'''Note:''' If you are running MIPAV on a Windows platform, before you place MIPAV in debug mode, it is helpful to exit from the program and then restart it again by holding the Crtl key while you select Start &gt; MIPAV. A DOS window opens on your desktop behind the MIPAV application windows.
 +
 
 +
'''Note:''' If you've contacted MIPAV developers about a problem with the program, they may ask you to save the debugging data in a text file. To do this, you would mark Redirect errors to file and type the name of the file in the box beside the check box. You can then send the file to them via e-mail: [mailto:MIPAV-Support@nih.gov MIPAV-Support@nih.gov].
 +
 
 +
<div id="DebugModeRemove"></div>
  
 
==== Removing MIPAV from debug mode ====
 
==== Removing MIPAV from debug mode ====
 
+
<ol>
<div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000"> 1 Select Help &gt; Program Options. The MIPAV Options dialog box opens. <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000">  2 Uncheck the <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Show Data/Debugging Output Window</font>'''</span> check box.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 18pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: -18pt; text-transform: none; vertical-align: baseline"><font color="#000000"> 3 Click Apply, then click Close.<br /></font></div>
+
<li> Select Help &gt; Program Options. The MIPAV Options dialog box opens.</li>
 +
<li> Uncheck the '''Show Data/Debugging Output Window''' check box.</li>
 +
<li>Click Apply, then click Close.</li>
 +
</ol>
  
 
When the debug mode is off, no error messages display on the Debug page in the Output window.
 
When the debug mode is off, no error messages display on the Debug page in the Output window.
  
===== MIPAV Options dialog box - the Other tab =====
+
<div id="GatherInformation"></div>
  
<div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000">
+
=== Gather software information ===
 +
Please gather the following information:<br />
 +
* '''Software version number:''' If you don't know the software version number, select Help &gt; About MIPAV in the MIPAV window. The About MIPAV dialog box opens. The software version number appears in that dialog box.
  
{| border="1" cellpadding="5"
+
* '''Steps taken to remedy the problem:''' Indicate what steps you took to solve the problem (if any).
|+ <div style="font-style: normal; margin-bottom: 3pt; margin-left: 0pt; margin-right: 0pt; margin-top: 9pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">'''<font color="#000000"> Figure 1. The Other tab of the MIPAV Options dialog box and the Debug tab of the Output window <br /></font>'''</div>
+
|-
+
|rowspan="1" colspan="3"
+
[[Image:ShowDebuggingInfortmation.jpg]]
+
|-
+
|
+
<div class="CellBody">Save dialog settngs</div>
+
| rowspan="1" colspan="2" |
+
<div class="CellBody">Saves the active dialog box settings in a log file.</div>
+
|-
+
|
+
<div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Record history</font>'''</span></div>
+
| rowspan="1" colspan="2" |
+
<div class="CellBody">Keeps a record of all of the actions-algorithms and utilities-performed on images. The history may be viewed on the History page in the Image Attributes dialog box while the actions are performed or in the XML file when an image is saved to an XML file.By default, this check box is clear.</div>
+
|-
+
|
+
<div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">LAX/Preferences memory check</font>'''</span></div>
+
| rowspan="1" colspan="2" |
+
<div class="CellBody">Enables MIPAV developers to debug the program. If you experience problems with the program, you may be asked to select this check box.</div> <div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Recommendation: </font>'''</span>Do not select this check box unless otherwise instructed by MIPAV development. By default, this check box is clear.</div>
+
|-
+
| rowspan="1" colspan="2" |
+
<div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Check on closing frame?</font>'''</span></div>
+
|
+
<div class="CellBody">Adds messages to confirm deletions of images. By default, this check box is clear. </div>
+
|-
+
|
+
<div class="CellBody">Log errors to:</div>
+
| rowspan="1" colspan="2" |
+
<div class="CellBody">Allows you to select the file in which MIPAV records any errors that occur. By default MIPAV logs errors to C:\Program Files\mipav\mipav.log unless the name and path of the log file was changed during installation.</div>
+
|-
+
|
+
<div class="CellBody">Debug levels: </div>
+
| rowspan="1" colspan="2" |
+
<div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Minor </font>'''</span>records only minor error messages in mipav.log.</div> <div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Algorithm</font>'''</span> records only error messages with algorithms in mipav.log.</div> <div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">FIleIO</font>'''</span> records only FileIO (file input and output) error messages in mipav.log.</div> <div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Comms</font>'''</span> records only error messages involving communications in mipav.log.</div> <div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Scripts</font>'''</span> records all error messages in mipav.log.</div>
+
|-
+
|
+
<div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Apply</font>'''</span></div>
+
| rowspan="1" colspan="2" |
+
<div class="CellBody">Saves and immediately applies all of the selected parameters in this dialog box.</div>
+
|-
+
|
+
<div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Cancel</font>'''</span></div>
+
| rowspan="1" colspan="2" |
+
<div class="CellBody">Disregards any changes you made in this dialog box, closes the dialog box, and does not save the specified options.</div>
+
|-
+
|
+
<div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Help</font>'''</span></div>
+
| rowspan="1" colspan="2" |
+
<div class="CellBody">Displays online help for this dialog box.</div>
+
  
|}
+
<div id="ContactSupport"></div>
 
+
<br /></font></div>
+
 
+
=== Gather software information ===
+
 
+
<div style="font-style: normal; font-weight: normal; margin-bottom: 6pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> Please gather the following information:<br /></font></div><div style="font-style: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: -24pt; text-transform: none; vertical-align: baseline">'''<font color="#000000">  <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Software version number</font>'''</span><br /></font>'''</div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> If you don't know the software version number, select Help &gt; About MIPAV in the MIPAV window. The About MIPAV dialog box opens. The software version number appears in that dialog box.<br /></font></div><div style="font-style: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: -24pt; text-transform: none; vertical-align: baseline">'''<font color="#000000">  <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Steps taken to remedy the problem</font>'''</span><br /></font>'''</div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> Indicate what steps you took to solve the problem (if any).<br /></font></div>
+
  
 
=== Contact MIPAV technical support ===
 
=== Contact MIPAV technical support ===
 +
To contact technical support, send an e-mail message to the following address: [mailto:MIPAV-Support@nih.gov MIPAV-Support@nih.gov]
  
<div style="font-style: normal; font-weight: normal; margin-bottom: 6pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> To contact technical support, send an e-mail message to the following address: <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> mcmatt@exchange.cit.nih.gov<br /></font></div>
+
[[Category: Help]]
 
+
[[Category: Getting started]]
This address is also listed on the MIPAV web site:
+
 
+
<div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 24pt; margin-right: 0pt; margin-top: 6pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> [http://mipav.cit.nih.gov/bugs.htm ]http://mipav.cit.nih.gov/bugs.htm<br /></font></div>
+

Latest revision as of 19:29, 12 April 2022

Troubleshooting MIPAV

If a problem occurs while you are using MIPAV, please contact us so that it can be addressed in a future release of the software. Please perform the following steps so that we have the correct information needed to resolve your problem:

  1. Place MIPAV in debug mode
  2. Gather software information
  3. Contact technical support

Placing MIPAV in debug mode

Debug mode

When you place MIPAV in debug mode, MIPAV creates a log of the software error messages that occur when MIPAV is being used. You can view these messages to pinpoint problems or you can save a copy to use as a reference when you contact technical support.

To turn debug mode on

  1. Select Help > Program Options. The MIPAV Options dialog box opens.
  2. Open the Other tab.
  3. Check the Show Data/Debugging Output Window check box. Then select the debugging level. The five debugging levels - from Minor to Scripting -correlate to the amount of debugging information provided on the Debug page and the amount of computer memory used. The Minor level provides the least amount of debugging information, and the Scripting level provides the highest level of the debugging information.
  4. Click Apply, then Click Close. From this point on, MIPAV places debugging data on the Debug page in the Output window. If software errors have occurred, messages appear in the Debug window.
  5. Save the debug information:
  • To save the debug information to a file, select File > Save Messages. The Save dialog box opens. Type a name for the file in File Name, and then click Save.
  • To copy the information to the clipboard, select Edit > Copy. You can then paste the information in any text editing, word processing, desktop publishing, or e-mail program of your choice.

Note: If you are running MIPAV on a Windows platform, before you place MIPAV in debug mode, it is helpful to exit from the program and then restart it again by holding the Crtl key while you select Start > MIPAV. A DOS window opens on your desktop behind the MIPAV application windows.

Note: If you've contacted MIPAV developers about a problem with the program, they may ask you to save the debugging data in a text file. To do this, you would mark Redirect errors to file and type the name of the file in the box beside the check box. You can then send the file to them via e-mail: MIPAV-Support@nih.gov.

Removing MIPAV from debug mode

  1. Select Help > Program Options. The MIPAV Options dialog box opens.
  2. Uncheck the Show Data/Debugging Output Window check box.
  3. Click Apply, then click Close.

When the debug mode is off, no error messages display on the Debug page in the Output window.

Gather software information

Please gather the following information:

  • Software version number: If you don't know the software version number, select Help > About MIPAV in the MIPAV window. The About MIPAV dialog box opens. The software version number appears in that dialog box.
  • Steps taken to remedy the problem: Indicate what steps you took to solve the problem (if any).

Contact MIPAV technical support

To contact technical support, send an e-mail message to the following address: MIPAV-Support@nih.gov