<!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>Environment variables overview</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">Environment variables overview</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('routingadmin/introduction.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('routingadmin/quick_ref.html');return(false);">How To</a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td"><a class="links" href="javascript:void(0)" onclick="top.openFile('routingadmin/app_overview.html');return(false);">Options</a></p>
            </td>
         </tr>
      </table><br><p class="para_topic">Routing relies on many environment variables to establish the location and names of necessary operating system files. These variables are defined in the ugii_env file by default. As with any NX environment variable, there are other methods of defining the variables for an NX session as well.</p>
      <div class="title_division">Environment variables</div>
      <p class="para_division">Variables that apply to a single application include the name of the application in the variable name. Variables that apply to all applications have ROUTING in their names.</p>
      <p class="para_division">The following variables define the application view file (.apv) for each Routing program. The variable provides either the file name only or the full path specification.</p>
      <ul class="hangingList">
         <li>
            <p class="para_item">UGII_ROUTE_ELEC_APP_VIEW &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Electrical APV</p>
         </li>
         <li>
            <p class="para_item">UGII_ROUTE_MECH_APP_VIEW &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Mechanical APV</p>
         </li>
         <li>
            <p class="para_item">UGII_ROUTE_LGCL_APP_VIEW &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logical APV</p>
         </li>
      </ul>
      <p class="para_division">If the APP_VIEW variable specifies only the APV file name, then the APV file must be in the directory specified by the variable UGII_ROUTING_APP_VIEW_DIR.</p>
      <p class="para_division">UGII_ROUTING_APP_VIEW_DIR &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Directory containing APV files</p>
      <p class="para_division">The Part Library View (.plv) file for each application determines the part selection hierarchy when using Routing's <b class="uiTerm">Place Part</b>. The APV file specifies the PLV file used for a particular application. If the APV file does not provide the complete path specification, then the PLV file must reside in one of the directories specified by UGII_EPLIB_PART_LIB_VIEW_PATH.
      </p>
      <p class="para_division">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UGII_EPLIB_PART_LIB_VIEW_PATH &nbsp;Directory paths of PLV files</p>
      <p class="para_division">Part Table files (.ptb) define Routing <b class="uiTerm">Characteristics</b> for parts and stock used by Routing. The PLV file of the application references the PTB files. If the PLV file does not provide the complete file path specification of a PTB file, then the PTB file must reside in one of the directories specified by UGII_EPLIB_TABLE_PATH.
      </p>
      <p class="para_division">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UGII_EPLIB_TABLE_PATH &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Directory paths of PTB files.</p>
      <p class="para_division">The PTB files reference existing part files, which may be part family template parts or individual part files. Any part referenced by a PTB &nbsp;must reside in one of the directories specified by the <b class="uiTerm">Part Path</b> variable for that application.
      </p>
      <ul class="hangingList">
         <li>
            <p class="para_item">UGII_ROUTE_ELEC_PART_PATH &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Electrical Part Path</p>
         </li>
         <li>
            <p class="para_item">UGII_ROUTE_MECH_PART_PATH &nbsp;&nbsp;&nbsp;&nbsp;Mechanical Part Path</p>
         </li>
         <li>
            <p class="para_item">UGII_ROUTE_LGCL_PART_PATH &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logical Part (symbol) Path</p>
         </li>
      </ul>
      <p class="para_division">&nbsp;If the PTB files reference Part Family template files, then <b class="uiTerm">Place Part</b> generates the member parts as needed. Member part files generate in the same directory as those created by standard Part Family unless the following variable is defined, which provides the Routing specific destination directory.
      </p>
      <p class="para_division">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UGII_ROUTING_MEMBER_SAVE_DIR:&nbsp;Directory in which Routing creates part family members from template files during <b class="uiTerm">Place Part</b> operation (no default value).
      </p>
      <p class="para_division">TCL files (.tcl) define the design rules for each application. Routing locates these files by the following variables.</p>
      <ul class="hangingList">
         <li>
            <p class="para_item">UGII_ROUTE_ELEC_TCL_DIR &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Electrical TCL directory</p>
         </li>
         <li>
            <p class="para_item">UGII_ROUTE_MECH_TCL_DIR &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Mechanical TCL directory</p>
         </li>
         <li>
            <p class="para_item">UGII_ROUTE_LGCL_TCL_DIR &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logical TCL directory</p>
         </li>
      </ul>
      <div class="title_division">Routing Electrical specific variables</div>
      <table bgcolor="#F0F0F0" cellpadding="2" cellspacing="4" width="95%" align="center">
         <tr valign="top">
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td"><code>UGII_RLIST_PATH</code></p>
            </td>
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td">The directory paths containing Routing List (RLIST) configuration files (such as ugroute_elec.cfg.</p>
            </td>
         </tr>
         <tr valign="top">
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td"><code>UGII_FMBD_FORMATS_FILE</code></p>
            </td>
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td">The file containing formats for the <b class="uiTerm">Formboard Annotation</b> functions.
               </p>
            </td>
         </tr>
         <tr valign="top">
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td"><code>UGII_FMBD_USE_LAYOUTS</code></p>
            </td>
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td">A switch that controls whether to use a split screen layout to display the harness and formboard assemblies in <b class="uiTerm">Formboard Sync</b>. If TRUE then split screen is used.
               </p>
            </td>
         </tr>
         <tr valign="top">
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td"><code>UGII_FMBD_PATTERN_DIR</code></p>
            </td>
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td">Directory that contains pattern part files for use in <b class="uiTerm">Formboard Frame Tool</b>.
               </p>
            </td>
         </tr>
         <tr valign="top">
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td"><code>UGII_FMBD_CGM_DIR</code></p>
            </td>
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td">Directory that contains CGM (.cgm) files for use in <b class="uiTerm">Formboard Frame</b>.
               </p>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F9F9F9" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><code>UGII_ROUTE_SKIP_LENGTH_ADDITION_CHARX</code></p>
            </td>
            <td bgcolor="#F9F9F9" colspan="1" rowspan="1" valign="top">
               <p class="para_td">This variable causes the system to skip checking for the LENGTH_ADDITION characteristics on a port, which can significantly improve the performance of the <b class="uiTerm">Auto Route</b> operation.
               </p>
            </td>
         </tr>
      </table><br><div class="title_division">Routing Mechanical specific variables</div>
      <table bgcolor="#F0F0F0" cellpadding="2" cellspacing="4" width="95%" align="center">
         <tr valign="top">
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td"><code>UGII_ROUTING_BOM_PATH</code></p>
            </td>
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td">Directory paths containing Routing <b class="uiTerm">Bill of Materials</b> part list format part files.
               </p>
            </td>
         </tr>
         <tr valign="top">
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td"><code>UGII_ROUTING_BEND_TABLES_PATH</code></p>
            </td>
            <td bgcolor="#f9f9f9" colspan="1" rowspan="1">
               <p class="para_td">Directory paths that Routing searches to locate bend table files referenced in the Application View file.</p>
            </td>
         </tr>
         <tr>
            <td bgcolor="#F9F9F9" colspan="1" rowspan="1" valign="top">
               <p class="para_td"><code>UGII_ROUTE_SKIP_ENGAGE_CHARX</code></p>
            </td>
            <td bgcolor="#F9F9F9" colspan="1" rowspan="1" valign="top">
               <p class="para_td">This variable causes the system to skip checking for the ENGAGE characteristics on a port, which can significantly improve the performance of the <b class="uiTerm">Place Part</b> operation.
               </p>
            </td>
         </tr>
      </table><br><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">ROUTING UNITS SYSTEMS: The example libraries are provided in both English and metric units.</p>
                  <p class="para_note_body">Environment variables are predefined for both unit systems in the default ugii_env file.</p>
                  <ul>
                     <li>
                        <p class="para_note_body">Where both versions are provided, those belonging to the inch system are initially commented out.&nbsp;These lines are identified by a plus sign following the pound sign comment character (#+) &nbsp;To change unit system examples, comment out those applicable to one system and uncomment those applicable to the other.</p>
                     </li>
                  </ul>
               </div>
            </td>
         </tr>
      </table>
   </body>
</html>