website/index.html in echi-converter-0.3.1 vs website/index.html in echi-converter-0.3.2

- old
+ new

@@ -31,11 +31,11 @@ <div id="main"> <h1>ECHI Converter</h1> <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/echi-converter"; return false'> <p>Get Version</p> - <a href="http://rubyforge.org/projects/echi-converter" class="numbers">0.3.1</a> + <a href="http://rubyforge.org/projects/echi-converter" class="numbers">0.3.2</a> </div> <h1>&#x2192; &#8216;echi-converter&#8217;</h1> <h2>The <span class="caps">ECHI</span> (External Call History Interface) Converter</h2> @@ -61,19 +61,21 @@ <li>Generate your schema via ActiveRecord Migrations</li> <li>Fetch Binary or <span class="caps">ASCII CSV</span> files from the Avaya <span class="caps">CMS</span> platform via <span class="caps">FTP</span></li> <li>Convert from the defined Binary format to <span class="caps">ASCII</span></li> <li>Insert the records into the defined database table using database transactions, via ActiveRecord, on a per file basis to support recovery on failure</li> <li>Change schema structure via <span class="caps">YML</span> configuration file to accommodate various releases of the <span class="caps">ECHI</span> format</li> + <li>Supports inserting agent names from agname.dat</li> <li>Runs as a daemon (via fork) on *NIX and a service on Windows</li> </ol> <ol> <li>Table names: <ol> <li>echi_records &#8211; stores all <span class="caps">ECHI</span> data </li> <li>echi_logs &#8211; stores a log entry for each file processed</li> + <li>echi_agents &#8211; stores the data from the agname.dat file</li> </ol></li> </ol> <h2>Requirements</h2> @@ -84,12 +86,13 @@ <li><a href="http://www.rubygems.org/">Rubygems v0.9.4+</a></li> <li><a href="http://activerecord.rubyforge.org/">ActiveRecord v1.15.3+</a></li> <li><a href="http://activesupport.rubyforge.org/">ActiveSupport v1.4.2+</a></li> <li><a href="http://daemons.rubyforge.org/">Daemons v1.0.7+</a></li> <li><a href="http://fastercsv.rubyforge.org/">FasterCSV v1.2.0+</a></li> - <li><a href="http://rake.rubyforge.org/">Rake v0.7.3+</a> - # <a href="http://win32utils.rubyforge.org/">Win32-service v.0.5.0+</a> (Manual install for Windows only)</li> + <li><a href="http://rake.rubyforge.org/">Rake v0.7.3+</a></li> + <li><a href="http://sporkmonger.com/projects/uuidtools/">UUIDTools v1.0.1+</a></li> + <li><a href="http://win32utils.rubyforge.org/">Win32-service v.0.5.0+</a> (Manual install for Windows only)</li> <li><a href="http://rubyforge.org/projects/seattlerb/">Hoe v1.2.2+</a></li> </ol> <h2>Installing</h2> @@ -134,10 +137,13 @@ <li>rake migrate (creates the tables required for the system)</li> <li>echi-converter (starts the server daemon, refer to its usage)</li> </ol> + <p>Note: When using a Windows <span class="caps">FTP</span> server, you must configure the <span class="caps">FTP</span> server to provide a <span class="caps">UNIX</span> directory listing format</p> + + <h2>Usage</h2> <ol> <li>echi-converter create myproject &#8211; create the local project to run the <span class="caps">ECHI</span> converter from</li> @@ -159,21 +165,29 @@ <p>For Windows:</p> <ol> - <li>echi-converter install myproject &#8211; install the service (must specify complete path such as c:\path\to\my\project &#8211; if the directory name or path has any spaces, please enclose the &#8216;myproject&#8217; in double quotes )</li> + <li>echi-converter install myproject &#8211; install the service (must specify complete path such as c:\path\to\my\project &#8211; if the directory name or path has any spaces, please enclose the &#8220;myproject&#8221; in double quotes )</li> <li>echi-converter start &#8211; start the service</li> <li>echi-converter stop &#8211; stop the service</li> <li>echi-converter pause &#8211; pause the service</li> <li>echi-converter resume &#8211; resume the service</li> <li>echi-converter status &#8211; returns the status of a configured service</li> <li>echi-converter uninstall &#8211; uninstall the service</li> <li>echi-converter delete &#8211; delete the service&#8221;</li> </ol> + <ol> + <li>If you would like to run the script interactively, you may also execute this command: + <ol> + <li>ruby &#8220;c:\myproject\lib\main_win32.rb&#8221;</li> + </ol></li> + </ol> + + <h2>Demonstration of usage</h2> <p>Start the daemon/service:</p> @@ -215,10 +229,10 @@ <h2>Contact</h2> <p>Comments are welcome. Send an email to <a href="mailto:jason@goecke.net">jason [at] goecke.net</a>.</p> <p class="coda"> - <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 4th November 2007<br> + <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 5th November 2007<br> Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a> </p> </div> <!-- insert site tracking codes here, like Google Urchin -->