<!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>Piping report</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_topic4" id="xps10_pagetitle">Piping report</div>
      <hr noshade="true">
      <p align="left"><img align="bottom" src="graphics/pipe_report.gif"></p>
      <p class="para_topic"><b class="uiTerm">Piping Report</b> creates a .csv file with system and user-defined range of data from all components and stocks.
      </p>
      <p class="para_topic">The contents and the layout of the report are defined by means of User_Preferences in the Routing Logical Application View file by specifying the following:</p>
      <ol type="1" start="1">
         <li>
            <p class="para_item">Names of the attributes to extract. These become the column titles in the reports first line.</p>
         </li>
         <li>
            <p class="para_item">Order of the .csv file columns.</p>
         </li>
         <li>
            <p class="para_item">Name of the post-processing program &ndash; if any &ndash; to be opened with the created report.</p>
         </li>
      </ol>
      <p class="para_topic">There is one output line for each component or stock. Following that line are as many lines as the component or stock has ports, one for each.</p>
      <p class="para_topic">In case a component or stock does not have an assigned name, it is searched for in the part. If it is not found, an empty field is displayed.</p>
      <p class="para_topic">Column titles in uppercase letters denote user-defined attributes; those in lowercase letters denote system-defined attributes.</p>
      <table cellpadding="2" cellspacing="4" width="95%" align="center">
         <colgroup span="1">
            <col span="1" width="77*">
            <col span="1" width="139*">
         </colgroup>
         <thead>
            <tr>
               <td align="center" bgcolor="silver" colspan="1" rowspan="1">
                  <p class="para_td">Column title</p>
               </td>
               <td align="center" bgcolor="silver" colspan="1" rowspan="1">
                  <p class="para_td">Description</p>
               </td>
            </tr>
         </thead>
         <tbody>
            <tr bgcolor="#f0f0f0">
               <td colspan="1" rowspan="1" valign="top">
                  <p class="para_td">type</p>
               </td>
               <td colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Has one of the following values:</p>
                  <ul>
                     <li>
                        <p class="para_item">Component</p>
                     </li>
                     <li>
                        <p class="para_item">Stock</p>
                     </li>
                     <li>
                        <p class="para_item">ComponentPort</p>
                     </li>
                     <li>
                        <p class="para_item">StockPort</p>
                     </li>
                  </ul>
               </td>
            </tr>
            <tr bgcolor="#f0f0f0">
               <td colspan="1" rowspan="1" valign="top">
                  <p class="para_td">portid</p>
               </td>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Displays a number which, in the .csv file, is unique per port.</p>
               </td>
            </tr>
            <tr>
               <td bgcolor="#F0F0F0" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">connportid</p>
               </td>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Displays a portid (the number of the connection port) if any.</p>
               </td>
            </tr>
            <tr>
               <td bgcolor="#F0F0F0" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">portnam</p>
                  <p class="para_td">connportname</p>
               </td>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Displays the names of the respective component ports.</p>
               </td>
            </tr>
            <tr>
               <td bgcolor="#F0F0F0" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">start/end</p>
                  <p class="para_td">runid</p>
               </td>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">Displays information about runs that might start or end at the port in question.</p>
               </td>
            </tr>
         </tbody>
      </table><br><p class="para_topic">Lines with the same value in the column titled &ldquo;id&rdquo; belong to the same component respective stock.</p>
      <div class="figure">
         <p align="center"><img align="bottom" src="graphics/report_ex.gif"></p>
      </div>
      <div class="title_figure">A Microsoft Excel file created by Piping Report</div>
      <p class="para_topic">The <b class="uiTerm">Piping Report</b> feature can be accessed in Routing Logical under <b class="uiTerm">Tools</b>. The application view file for Routing Logical, <code>ugroute_lgl_mm.xml</code>, must have the following user preferences for this feature to work. Values for the user preferences are given as an example.
      </p>
      <table cellpadding="2" cellspacing="4" width="95%" align="center">
         <colgroup span="1">
            <col span="1" width="120*">
            <col span="1" width="95*">
         </colgroup>
         <thead>
            <tr>
               <td align="center" bgcolor="silver" colspan="1" rowspan="1">
                  <p class="para_td">Name</p>
               </td>
               <td align="center" bgcolor="silver" colspan="1" rowspan="1">
                  <p class="para_td">Value(s)</p>
               </td>
            </tr>
         </thead>
         <tbody>
            <tr bgcolor="#f0f0f0">
               <td colspan="1" rowspan="1" valign="top">
                  <p class="para_td"><code>PIPING_REPORT_DEFINITIONS</code></p>
               </td>
               <td colspan="1" rowspan="1" valign="top">
                  <p class="para_td">ASS_NAME</p>
                  <p class="para_td">RUN_ID</p>
                  <p class="para_td">PCRA</p>
                  <p class="para_td">REFERENCE_ID</p>
                  <p class="para_td">PCTA</p>
                  <p class="para_td">PLFA</p>
                  <p class="para_td">PART_NUMBER</p>
                  <p class="para_td">PART_NAME</p>
                  <p class="para_td">NPS</p>
               </td>
            </tr>
            <tr bgcolor="#f0f0f0">
               <td colspan="1" rowspan="1" valign="top">
                  <p class="para_td"><code>PIPING_REPORT_POST_PROCESS</code></p>
               </td>
               <td bgcolor="#F4F4F4" colspan="1" rowspan="1" valign="top">
                  <p class="para_td">C:\apps\MSOffice\OFFICE11\EXCEL.EXE</p>
               </td>
            </tr>
         </tbody>
      </table><br><p class="para_topic">There can be any attribute listed in the PIPING_REPORT_DEFINITIONS preference.</p>
      <p class="para_topic">Post processing of the created report will not be done if PIPING_REPORT_POST_PROCESS preference has not been specified.</p>
   </body>
</html>