<!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>Config settings for error reporting</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">Config settings for error reporting</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('ugtojt/error_report_ov.html');return(false);">Error reporting</a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td"><a class="links" href="javascript:void(0)" onclick="top.openFile('ugtojt/error_log_file.html');return(false);">Log file</a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td"><a class="links" href="javascript:void(0)" onclick="top.openFile('ugtojt/error_messages.html');return(false);">Messages</a></p>
            </td>
         </tr>
      </table><br><p class="para_topic">There are three configuration options in the translator configuration file for the error reporting mechanism, LogReporting, ConsoleReporting and LogFileName.</p>
      <p class="para_topic">Using these configuration options, you can specify what types of messages to capture, and whether to send them to the translator log file, a command prompt window (DOS window for Microsoft&reg; Windows&reg; and shell for Unix), or to both. </p>
      <p class="para_topic">When using the translator within NX on Windows (e.g. <b class="uiTerm">File</b> &rarr; <b class="uiTerm">Export</b> &rarr; <b class="uiTerm">Teamcenter Visualization</b>), the messages can be captured only in the log file.
      </p>
      <div class="title_division">LogReporting and ConsoleReporting</div>
      <p class="para_division">You can set the values of the LogReporting and ConsoleReporting options in the translator configuration file to NONE, or any combination of ERROR, WARNING, or INFO.</p>
      <ul>
         <li>
            <p class="para_item">LogReporting: Sends the messages to the translator log file</p>
         </li>
         <li>
            <p class="para_item">ConsoleReporting: Sends the messages to a command prompt window </p>
         </li>
      </ul>
      <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">If you set NONE as the value for both the options, the earlier error reporting mechanism is used.</p>
               </div>
            </td>
         </tr>
      </table>
      <p class="para_division">For example, if you set the configuration options as: </p>
      <p class="para_division">LogReporting = &rdquo;ERROR,INFO&rdquo; </p>
      <p class="para_division">ConsoleReporting = &rdquo;NONE&rdquo;, </p>
      <p class="para_division">then, the new error reporting mechanism is used and it sends ERROR and INFO messages to the translator log file.</p>
      <div class="title_division">LogFileName</div>
      <p class="para_division">The LogFileName configuration option in the translator configuration file determines the name of the log file. You can configure the log file name by including the following parameters as part of the name:</p>
      <ul>
         <li>
            <p class="para_item">UG_PART: The NX part name, not including the .prt extension.</p>
         </li>
         <li>
            <p class="para_item">TIME: Date and time of the translation.</p>
         </li>
         <li>
            <p class="para_item">PID: Process ID of the translation.</p>
         </li>
         <li>
            <p class="para_item">USER: User name of person performing the translation.</p>
         </li>
         <li>
            <p class="para_item">&lt;Path to log files&gt;: Any path you want your log files to get created at.</p>
         </li>
         <li>
            <p class="para_item">&lt;String&gt;: Any string you want to add in your log file name. </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"> Do not use \ or / in this parameter.</p>
                     </div>
                  </td>
               </tr>
            </table>
         </li>
      </ul>
      <p class="para_division">The log file name is created based on the parameters you select and the order in which you set them. An underscore (_) is added between each value and _log is appended to the end of the name.</p>
      <p class="para_division">For example, if you set the configuration option as:</p>
      <p class="para_division">LogFileName = &ldquo;UG_PART,USER,TIME,chasis Test&rdquo;</p>
      <p class="para_division">The following log file name created is:</p>
      <p class="para_division"> mypart_myname_TueSep141743202004_chassis Test_log </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">There is no blank space after the comma when two or more parameters are specified. The translator interprets a blank space as the end of the parameter string, except when the blank space is within the &lt;String&gt; parameter.</p>
                  <p class="para_note_body">The compiled log file name compiled does not include the following characters in the TIME parameter:</p>
                  <p class="para_note_body">':' and a space. </p>
               </div>
            </td>
         </tr>
      </table>
      <p class="para_division">The UG_PART parameter can have different values depending on the translator input:</p>
      <ul>
         <li>
            <p class="para_item">When translations are performed through NX/NX Manager, only one translator log file is generated. In this case, the UG_PART takes the first part/assembly&rsquo;s name that is translated in NX session.</p>
         </li>
         <li>
            <p class="para_item">When the input is from Teamcenter Engineering (e.g., @DB\model name\model revision), the UG_PART is the model name_model revision. </p>
         </li>
      </ul>
      <p class="para_division">If the error messages file cannot be written to the file designated in the LogFileName option, then it is written to a default file that is created, default_log, in the current working directory. If this also fails, no log file is created.</p>
   </body>
</html>