<!DOCTYPE html
  PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<!--
Copyright (c) 2006 UGS Corp.

All Rights Reserved.

This software and related documentation are proprietary to UGS Corp.
-->
<html>
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
      <title>Check-Mate Viewer Options</title>
      <script language="javaScript">
        abridged="false";
        displayConditions=new Array();
      </script>
      <link type="text/css" href="../css/main_styles.css" rel="stylesheet">
   </head>
   <body class="bodydocs" onload="top.pageLoader()" bgcolor="#FFFFFF">
      <div class="title_topic3" id="xps10_pagetitle">Check-Mate Viewer Options</div>
      <hr noshade="true">
      <table cellspacing="4" align="center">
         <tr valign="top">
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td"><a class="links" href="javascript:void(0)" onclick="top.openFile('checkmate/cm_viewer_ov.html');return(false);">Overview</a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td"><a class="links" href="javascript:void(0)" onclick="top.openFile('checkmate/cm_viewer_ht.html');return(false);">How To</a> 
               </p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td">Options</p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td">Related Topics</p>
            </td>
         </tr>
      </table><br><table cellspacing="2" width="100%" align="center">
         <colgroup span="1">
            <col span="1" width="77*">
            <col span="1" width="122*">
         </colgroup>
         <tr>
            <th bgcolor="#c0c0c0" colspan="1" rowspan="1">
               <p class="para_th">Item</p>
            </th>
            <th bgcolor="#c0c0c0" colspan="1" rowspan="1">
               <p class="para_th">Description</p>
            </th>
         </tr>
         <tr>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><b class="uiTerm">File</b></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td">Provides the following options:</p>
               <ul>
                  <li>
                     <p class="para_item"><b class="uiTerm">Save Selections</b> &mdash; starts the <b class="uiTerm">Save</b> dialog. Enter a file specification. The software creates a text file with a reference to the report.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Load Selections</b> &mdash; starts the <b class="uiTerm">Open</b> dialog. You can select a report to load into the<b class="uiTerm"> Check-Mate Viewer</b>. On start up the program reloads itself from the previously loaded file structure using the saved search path. 
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Exit</b> &mdash; exits the viewer.
                     </p>
                  </li>
               </ul>
            </td>
         </tr>
         <tr>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><b class="uiTerm">Options</b></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td">Provides the following options:</p>
               <ul>
                  <li>
                     <p class="para_item"><b class="uiTerm">Immediate Refresh</b> &mdash; when selected, immediately updates the results data when a log file is added or removed from the selection list. When cleared, you must click <img align="bottom" src="graphics/refresh_data_display_ico.gif" border="0"> <b class="uiTerm"> Refresh Data Display</b> to update the results display.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Part Names Include Paths</b> &mdash; when selected, displays the full path for each part file in the results display. When cleared, the results displays a shortened name. 
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Use All Results in Checkers</b> &mdash; when turned on, the results display for a checker contains all historical results data. When turned off, the program uses the <b class="uiTerm">History Depth</b> filter to determine how much to display in the results for a checker.
                     </p>
                  </li>
               </ul>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><b class="uiTerm">Export</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td"> Provides the following option:</p>
               <ul>
                  <li>
                     <p class="para_item">HTML &mdash; starts the Save dialog. Exports the raw data from the viewer to a set of web pages in HTML form.</p>
                  </li>
               </ul>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><b class="uiTerm">Help</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td">Displays <b class="uiTerm">Check-Mate Viewer</b> help.
               </p>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><img align="bottom" src="graphics/set_search_folders_ico.gif" border="0"><b class="uiTerm"> Set Search Folders</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td">Starts the <b class="uiTerm">Search Directories</b> dialog box. This dialog sets up search paths for Check-Mate log files. A search path is a set of directories that are examined for any mqclog files. The default is to only search the directory, and not the subdirectories. If the path ends with &quot;...&quot;, then subdirectories are also searched. The search routines ignore duplicate mqclog files and all log files that do not have read permission. 
               </p>
               <p class="para_td">The <b class="uiTerm">Search Directories</b> dialog provides the following options:
               </p>
               <ul>
                  <li>
                     <p class="para_item"><b class="uiTerm">Search Paths</b> list box &mdash; displays the search paths.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><img align="bottom" src="graphics/move_up_ico.gif" border="0"> &mdash; moves a search path up one level in the <b class="uiTerm">Search Paths</b> list box.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><img align="bottom" src="graphics/search_dir_check_ico.gif" border="0"> &mdash; accepts changes to a selected list item.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><img align="bottom" src="graphics/search_dir_add_ico.gif" border="0"> &mdash; adds the path from the Path box to the Search Paths list box.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><img align="bottom" src="graphics/search_dir_delete_ico.gif" border="0"> &mdash; removes a selected search path from the Search Paths list box.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><img align="bottom" src="graphics/search_dir_move_down_ico.gif" border="0"> &mdash;  moves a search path down one level in the Search Paths list box.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Path</b> box &mdash; lets you enter a path to add to the <b class="uiTerm">Search Paths</b> list box. 
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Include subdirectories</b> &mdash; Includes subdirectories for search path.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">OK</b> &mdash; Captures current changes and dismisses the dialog box.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Cancel</b> &mdash; Ignores current changes and dismisses dialog box.
                     </p>
                  </li>
               </ul>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><img align="bottom" src="graphics/refresh_data_display_ico.gif" border="0"><b class="uiTerm"> Refresh Data Display</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td">Updates the results display after the selection of new log files. The option is unavailable until changes are made to the set of selected log files.</p>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><img align="bottom" src="graphics/display_error_info_ico.gif" border="0"> <b class="uiTerm"> Display Error Info</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td">Provides additional error text when an application error occurs. This button is unavailable until an error occurs. Initial error status displays on the <b class="uiTerm">Status</b> line at the bottom of the display.
               </p>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><b class="uiTerm">Part Filter</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td">Performs a wildcard match between the specified string and all parts from the log files. Only matching strings display in the results windows.</p>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><b class="uiTerm">Checker Filter</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td">Performs a wildcard match between the specified string and all checkers from the log files. Only matching strings display in the results windows.</p>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><b class="uiTerm">History Depth</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td">Controls the number of historical runs that are considered for a given checker.</p>
            </td>
         </tr>
         <tr valign="top">
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td"><b class="uiTerm">Log File Tree</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td">The left pane displays a tree showing the paths to Check-Mate log files. The entries in the tree correspond to directories entered as search directories using the <b class="uiTerm">Set Search Folders</b> option. Each entry under the root corresponds to a search path that contains Check-Mate log files.
               </p>
               <p class="para_td">The following color coded icons indicate the items status as follows:</p>
               <ul>
                  <li>
                     <p class="para_item"><img align="bottom" src="graphics/green_check_box_ico.gif" border="0"> A green check mark indicates that either the log file is selected or that all files in this directory are selected.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><img align="bottom" src="graphics/dim_check_box_ico.gif" border="0"> A gray check mark indicates that only some Check-Mate log files in a directory are selected.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><img align="bottom" src="graphics/empty_check_box_ico.gif" border="0"> A clear check box indicates that either the file is not selected or no Check-Mate log files in the directory are selected.
                     </p>
                  </li>
               </ul>
               <p class="para_td"><em>Right-click menu options</em></p>
               <p class="para_td">The following right-click menu options are available on a selected item in the tree:</p>
               <ul>
                  <li>
                     <p class="para_item"><b class="uiTerm">Add</b> &mdash; adds the file or directory to the results output.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Remove</b> &mdash; removes a file or directory from the results output.
                     </p>
                     <table border="0">
                        <tr>
                           <td valign="top" align="left"><img align="left" src="../graphics/note.gif" alt="Note" title="Note"></td>
                           <td valign="bottom" align="left" width="100%">
                              <div class="para_note">
                                 <p class="para_note_body">Adding or removing a directory adds or removes all of the log files in that directory and any subdirectories to/from the results output. </p>
                              </div>
                           </td>
                        </tr>
                     </table>
                  </li>
               </ul>
            </td>
         </tr>
         <tr valign="top">
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td"><b class="uiTerm">Results Area</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td">The <b class="uiTerm">Results Area</b> displays summary and detailed information about the contents of the selected log files. The following 6 tabs control what information displays:
               </p>
               <ul>
                  <li>
                     <p class="para_item"><b class="uiTerm">Info</b> &mdash; contains summary information about the selected set of log files. This summary information includes the number of parts found in the log files, the total number of checker tests run, and a count of the number of errors.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">All Results</b> &mdash; contains two regions. The upper region is a tree showing each part that was checked and all the checker rules that executed against the part file. The lower portion of the region contains detailed information on the selected part or checker test. The results of each test are summaries with the following icons:
                     </p>
                     <ul>
                        <li>
                           <p class="para_item"><img align="bottom" src="graphics/blank_ico.gif" border="0"> &mdash; indicates a normal result from the checker rule (Pass).
                           </p>
                        </li>
                        <li>
                           <p class="para_item"><img align="bottom" src="graphics/blue_ico.gif" border="0"> &mdash; indicates an informational message was generated by the checker.
                           </p>
                        </li>
                        <li>
                           <p class="para_item"><img align="bottom" src="graphics/yellow_diamomd_ico.gif" border="0"> &mdash; indicates a warning message was generated by the checker.
                           </p>
                        </li>
                        <li>
                           <p class="para_item"><img align="bottom" src="graphics/red_ico.gif" border="0"> &mdash; indicates an error message was generated by the checker.
                           </p>
                        </li>
                        <li>
                           <p class="para_item"><img align="bottom" src="graphics/orange_ico.gif" border="0"> &mdash; indicates that the test resulted in both warning and error messages.
                           </p>
                        </li>
                     </ul>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Failures</b> &mdash; shows the same basic information as the <b class="uiTerm">All Results</b> tab except the data filters down to only part files and tests that had an error status returned.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Checkers</b> &mdash; shows the result information organized by checker instead of by parts. The entries are organized under a tree for <b class="uiTerm">Pass</b>, <b class="uiTerm">Info</b>, <b class="uiTerm">Warning</b> and <b class="uiTerm">Failed</b> tests. A given test can be listed under more than one heading.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Differences</b> &mdash; shows a summary of any tests that have had a status change from the previous run to the current results.
                     </p>
                  </li>
                  <li>
                     <p class="para_item"><b class="uiTerm">Analysis</b> &mdash; performs some basic summary analysis of the data and presents the information in a table. The analysis information includes the checks with the highest failure rate and checks with the highest passing rates.
                     </p>
                  </li>
               </ul>
            </td>
         </tr>
         <tr valign="top">
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td"><b class="uiTerm">Detail Area</b></p>
            </td>
            <td bgcolor="#F7F7F7" colspan="1" rowspan="1">
               <p class="para_td">Provides details on items selected from the <b class="uiTerm">Results Area</b>. This area is not available for the <b class="uiTerm">Info</b> and <b class="uiTerm">Analysis</b> property pages.
               </p>
               <p class="para_td">The following MB3 option is available on selected items:</p>
               <ul>
                  <li>
                     <p class="para_item"><b class="uiTerm">Details</b> &mdash; provides additional information.
                     </p>
                  </li>
               </ul>
            </td>
         </tr>
      </table><br></body>
</html>