<!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 Environment Variables</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_topic2" id="xps10_pagetitle">Check-Mate Environment Variables</div>
      <hr noshade="true">
      <table cellspacing="4" align="center">
         <tr>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"> <a class="links" href="javascript:void(0)" onclick="top.openFile('checkmate/cm_intro.html');return(false);">Overview</a><a name="ndxgenid_checkmate15"></a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"> <a class="links" href="javascript:void(0)" onclick="top.openFile('checkmate/intro_how_link.html');return(false);">How To</a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"> <a class="links" href="javascript:void(0)" onclick="top.openFile('checkmate/intro_opt_link.html');return(false);">Options</a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1" valign="top">
               <p class="para_td"> <a class="links" href="javascript:void(0)" onclick="top.openFile('checkmate/intro_rel_link.html');return(false);">Related Topics</a></p>
            </td>
         </tr>
      </table><br><p class="para_topic">You can define environment variables in the ugii_env.dat file or in the shell in which the session runs. The syntax for setting environment variables is specific to the platform and shell. Consult your system administrator if you do not know how to define an environment variable.</p>
      <table cellspacing="3" align="center">
         <tbody>
            <tr valign="top">
               <th bgcolor="#c0c0c0" colspan="1" rowspan="1" valign="top">
                  <p class="para_th">Environment Variable</p>
               </th>
               <th bgcolor="#c0c0c0" colspan="1" rowspan="1" valign="top">
                  <p class="para_th">Description</p>
               </th>
            </tr>
            <tr valign="top">
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td"><a name="ndxgenid_checkmate16"></a><b class="literalText">UGCHECKMATE_DIR</b></p>
               </td>
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Specifies the directory location for the Check-Mate product. By default, it is <b class="literalText">UGII_BASE_DIR</b>/<b class="literalText">ugcheckmate</b>.
                  </p>
               </td>
            </tr>
            <tr valign="top">
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td"><a name="ndxgenid_checkmate17"></a><b class="literalText">UGII_CHECKMATE_DEFAULT_CHECKER</b></p>
               </td>
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1">
                  <p class="para_td">Specifies a list of selected checkers when Check-Mate first starts. These checkers appear in the <b class="uiTerm">Selected Tests</b> list box on the <b class="uiTerm">Tests</b> tab. You should reference the checkers by class name (not display name). If you specify more than one checker, separate the names with commas.
                  </p>
               </td>
            </tr>
            <tr>
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td"><a name="ndxgenid_checkmate18"></a><b class="literalText">UGII_CHECKMATE_FLAG_FILTER</b></p>
               </td>
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1">
                  <p class="para_td">Set this variable to either the class name or the descriptive name of the item to check for overall pass/fail status when you use the <b class="uiTerm">Analysis</b>&rarr; <b class="uiTerm">Check-Mate</b>&rarr; <b class="uiTerm">Show Results Flag</b> menu option. For example:
                  </p>
                  <p class="para_td"><b class="literalText">UGII_CHECKMATE_FLAG_FILTER</b>= &quot;Misaligned Geometry&quot;
                  </p>
                  <p class="para_td">uses the descriptive name of a checker. If the environment variable is not set, then the software uses the entire part results. Setting the environment variable to a blank string also tests against the entire part results.</p>
               </td>
            </tr>
            <tr>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top"><a name="xml_output"></a><p class="para_td"><b class="literalText">UGII_CHECKMATE_OUTPUT_MQCLOG</b></p>
               </td>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1">
                  <p class="para_td">Controls whether the output log file is XML or a standard text format. When set to 0, the output is XML. When set to 1, the output is a standard text file.</p>
               </td>
            </tr>
            <tr>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td"><a name="ndxgenid_checkmate19"></a><b class="literalText">UGCHECKMATE_USER_DIR</b></p>
               </td>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Specifies the directory location where:</p>
                  <ul>
                     <li>
                        <p class="para_item">User-defined checker/profile DFA files are loaded from and saved to.</p>
                     </li>
                     <li>
                        <p class="para_item">Testing result log files are saved.</p>
                     </li>
                     <li>
                        <p class="para_item">If the <b class="literalText">UGCHECKMATE_USER_DIR</b>/startup folder exists, NX reads menu files, toolbar files, etc. from this location.  The menu files and toolbar files generated from the Check-Mate authoring tool are saved here.
                        </p>
                     </li>
                  </ul>
               </td>
            </tr>
            <tr>
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td"><a name="ndxgenid_checkmate20"></a><b class="literalText">UGII_CHECKMATE_LOG_DIR</b></p>
               </td>
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1">
                  <p class="para_td">Specifies the default directory for the log file. Check-Mate uses this default for the <b class="uiTerm">Directory</b> text box in the <b class="uiTerm">Run Tests</b> tab. You can enter a different value, which then becomes the default for the next run of checkers. The value you enter is not persistent. The next time NX starts, Check-Mate uses the environment variable to get the default value again. The system default is <b class="literalText">UGCHECKMATE_USER_DIR</b>.
                  </p>
               </td>
            </tr>
            <tr>
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1">
                  <p class="para_td"><a name="ndxgenid_checkmate21"></a><b class="literalText">UGII_CHECKMATE_OVERRIDE</b></p>
               </td>
               <td bgcolor="#f4f4f4" colspan="1" rowspan="1">
                  <p class="para_td">Specifies which users are authorized to override test results. Specify users by their login names. If you specify more than one user name, separate the names with commas.</p>
                  <p class="para_td">This environment variable is only effective if you have previously saved results to the part file. You can save results by choosing <b class="uiTerm">Run Tests</b>&rarr; <b class="uiTerm">Save Part After Checking</b>&rarr; <b class="uiTerm">Always Saved</b>.
                  </p>
               </td>
            </tr>
            <tr>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td"><b class="literalText">UGCHECKMATE_XMLLOG_XSL_FILE</b> 
                  </p>
               </td>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Indicates the URL/path of the XSL file used in a Check-Mate XML log file. For example: <b class="literalText">UGCHECKMATE_XMLLOG_XSL_FILE</b>=<i class="pathName">file://c:/nx/ugcheckmate/examples/checkmate_log.xsl</i>  or <b class="literalText">UGCHECKMATE_XMLLOG_XSL_FILE</b>=<i class="pathName">http://www.somecompany.com/company_log.xsl</i>.
                  </p>
               </td>
            </tr>
            <tr>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td"><b class="literalText">UGCHECKMATE_MENU_TEMPLATE_FILE</b></p>
               </td>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Specifies the file used to create a menu file when authoring tests. The default, is <b class="literalText">UGII_CHECKMATE_DIR</b>\<b class="literalText">user_defined_menu_template.txt</b>.
                  </p>
               </td>
            </tr>
            <tr>
               <th align="left" bgcolor="#c0c0c0" colspan="1" rowspan="1" valign="top">
                  <p class="para_th">Configuration Environment Variables</p>
               </th>
               <th align="left" bgcolor="#c0c0c0" colspan="1" rowspan="1" valign="top">
                  <p class="para_th">Description</p>
               </th>
            </tr>
            <tr>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top"><a name="ndxgenid_checkmate22"></a><p class="para_td"><b class="literalText">UGCHECKMATE_CONFIG</b></p>
               </td>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Specifies the file used to define environment variables you can use to configure Check-Mate's checkers, profiles, and categories. This variable is defined in the <b class="literalText">ugii_env.dat</b> or <b class="literalText">.ugii_env</b> file by default.
                  </p>
               </td>
            </tr>
            <tr>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top"><a name="ndxgenid_checkmate23"></a><p class="para_td"><b class="literalText">UGCHECKMATE_ALLOW_CHECKER</b></p>
               </td>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Specifies which checkers are available for selection in the <b class="uiTerm">Test</b> tab's <b class="uiTerm">Category</b> list box.  If defined without any value, none of the checkers are available for selection. This variable takes precedence over the <b class="literalText">UGCHECKMATE_HIDE_CHECKER</b> variable when both variables are defined.
                  </p>
                  <p class="para_td">Example: </p>
                  <p class="para_td"><b class="literalText">UGCHECKMATE_ALLOW_CHECKER</b>= &quot;%mqc_update_all_features,%mqc_report_dimension&quot;
                  </p>
               </td>
            </tr>
            <tr>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top"><a name="ndxgenid_checkmate24"></a><p class="para_td"><b class="literalText">UGCHECKMATE_HIDE_CHECKER</b></p>
               </td>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Specifies which checkers are unavailable for selection in the <b class="uiTerm">Test</b> tab's <b class="uiTerm">Category</b> list box.
                  </p>
                  <p class="para_td">Example:</p>
                  <p class="para_td"><b class="literalText">UGCHECKMATE_HIDE_CHECKER</b>= &quot;%mqc_check_misaligned_object,%mqc_check_dim_attach_solid&quot;
                  </p>
               </td>
            </tr>
            <tr>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top"><a name="ndxgenid_checkmate25"></a><p class="para_td"><b class="literalText">UGCHECKMATE_ALLOW_CATEGORY</b></p>
               </td>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Specifies which categories are available for selection in the <b class="uiTerm">Test</b> tab's <b class="uiTerm">Category</b> list box. If defined without any value, none of the categories are available for selection. This variable takes precedence over <b class="literalText">UGCHECKMATE_HIDE_CATEGORY</b> when both variables are defined.
                  </p>
                  <p class="para_td">Example:</p>
                  <p class="para_td"><b class="literalText">UGCHECKMATE_ALLOW_CATEGORY</b>= &quot;Modeling&quot;
                  </p>
               </td>
            </tr>
            <tr>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top"><a name="ndxgenid_checkmate26"></a><p class="para_td"><b class="literalText">UGCHECKMAGE_HIDE_CATEGORY</b></p>
               </td>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Specifies which categories are unavailable for selection in the <b class="uiTerm">Test</b> tab's <b class="uiTerm">Category</b> list box.
                  </p>
               </td>
            </tr>
            <tr>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top"><a name="ndxgenid_checkmate27"></a><p class="para_td"><b class="literalText">UGCHECKMATE_MAX_DISPLAY_ENTITIES</b></p>
               </td>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Lets you specify a positive integer for the maximum number of entities that can display for each checker in the <b class="uiTerm">Results</b> list box of the<b class="uiTerm"> View Results</b> tab. If the variable is not defined, the software displays as many entities as required to log the results. If only pass/fail results are desired, set the value to 0.
                  </p>
               </td>
            </tr>
            <tr>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top"><a name="ndxgenid_checkmate28"></a><p class="para_td"><b class="literalText">UGCHECKMATE_MAX_LOG_ENTITIES</b></p>
               </td>
               <td align="left" bgcolor="#f4f4f4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Lets you specify a positive integer which is the maximum number of entities that can be logged to the reporting software. If the variable is not defined, the software uses 999999 as the maximum number.</p>
               </td>
            </tr>
         </tbody>
      </table><br></body>
</html>