<!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>Generate Run ID</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">Generate Run ID</div>
      <hr noshade="true">
      <table cellspacing="4" align="center">
         <colgroup span="1">
            <col span="1" width="99*">
            <col span="2" width="100*">
         </colgroup>
         <tr valign="top">
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td"><a class="links" href="javascript:void(0)" onclick="top.openFile('routingtools/run_nav_run_overview.html');return(false);">Run Navigator 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('routingtools/run_nav_check_box.html');return(false);">How To</a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td">Options</p>
            </td>
         </tr>
      </table><br><p class="para_topic">The interactive function that generates a Run ID, described here, is a plug&ndash;in.&nbsp;A site may replace this function with a custom function that returns a text string. The custom program need not be interactive, and may provide a database generated Run ID.</p>
      <div class="title_division">Default dialog box</div>
      <p class="para_division">By choosing the <b class="uiTerm">Generate</b> button on the <b class="uiTerm">Define Run</b> dialog box (previous section), the entry for the Run ID can be automatically generated. If using the default method, the <b class="uiTerm">Generate Run ID</b> dialog box displays.
      </p>
      <p class="para_division">The dialog box builds a <b class="uiTerm">Run ID</b> by filling in values in the format &lt;Prefix&gt;&lt;incremented number&gt;&lt;Suffix&gt;.
      </p>
      <p class="para_division">&lt;Prefix&gt; is whatever is entered into the dynamic input box for <b class="uiTerm">Prefix</b>. &nbsp;&lt;Suffix&gt; is whatever is entered in the <b class="uiTerm">Suffix</b> box.
      </p>
      <p class="para_division">The value for &lt;incremented number&gt; is derived from the chosen <b class="uiTerm">Number of Digits</b>, <b class="uiTerm">Start Value</b>, and <b class="uiTerm">Increment</b>. <b class="uiTerm">Number of Digits</b> has the options 1, 02, 003, 0004 and 00005, corresponding respectively to 1, 2, 3, 4, or 5 digits in the incremented number.
      </p>
      <p class="para_division">The <b class="uiTerm">Start Value</b> has a meaning only if there are no other runs existing that have the same prefix and suffix. If there are none, then the incremented number is assigned the <b class="uiTerm">Start Value</b>. If there is one or more runs with the same prefix and suffix in their Run ID, the incremented number is determined by adding the <b class="uiTerm">Increment Value</b> given in the dynamic input box to the highest valued number of the existing Run IDs.
      </p>
      <p class="para_division">At the bottom of the dialog box the <b class="uiTerm">New Run ID</b> displays. &nbsp;This label is updated whenever you press &lt;Enter&gt; in an entry box or changes an option menu choice.
      </p>
      <p class="para_division">When you choose <b class="uiTerm">OK</b>, you will return to the <b class="uiTerm">Define Run</b> dialog box with the string for <b class="uiTerm">New Run ID</b> inserted into the <b class="uiTerm">Run ID Text Entry</b> box.
      </p>
      <div class="title_division">Plug&ndash;in</div>
      <p class="para_division">A custom plug&ndash;in program may replace the <b class="uiTerm">Generate Run ID</b> function provided. This program simply returns a string that is inserted into the <b class="uiTerm">Run ID Entry</b> box.
      </p>
      <p class="para_division">An entry in the APV file is required to define the plug&ndash;in. &nbsp;An example entry appears below. Refer to the <a class="links" href="javascript:void(0)" onclick="top.popUpPage('routingadmin/index.html?goto=routingadmin/title_page.html&vars=-aux,-home','linkInter','menubar=yes,status=yes,resizable=yes,toolbar=yes,scrollbars=yes,location=no,directories=no');return(false);">Routing Systems Configuration Guide</a> for more information on implementing a plug-n program.
      </p><pre class="indent">&lt;!&mdash;
UFD_ROUTE_gen_run_id is the plug-in used to generate a Run
Identifier string
&rarr;
&lt;Plugin&gt;
&lt;Name&gt;
				ROUTE_GEN_RUN_ID
		&lt;/Name&gt;
			&lt;External_Dll&gt;
&lt;DLL_Name&gt;
					ufd_route_gen_run_id
&lt;/DLL_Name&gt;
&lt;Entry_point&gt;
						UFD_ROUTE_gen_run_id
					&lt;/Entry_point&gt;
&lt;/External_Dll&gt;
&lt;/Plugin&gt;</pre></body>
</html>
