index.txt in echi-converter-0.3.8

- old
+ new

@@ -3,17 +3,15 @@
 h1. &#x2192; 'echi-converter'
 
 
 h2. The ECHI (External Call History Interface) Converter 
 
-Provides a Ruby based utility for fetching Avaya CMS / ECHI files in binary/ASCII form from an FTP server, converting them, if necessary, to ASCII and then inserting them into a database via ActiveRecord.  With this
-utility you only need the standard Avaya CMS Release 13 or better without any additional software or utilities
-from Avaya, as this utility will process either binary or ASCII output from the Avaya CMS.
+Provides a Ruby based utility for fetching Avaya CMS / ECHI files in binary/ASCII form from an FTP server, converting them, if necessary, to ASCII and then inserting them into a database via ActiveRecord.  With this utility you only need the standard Avaya CMS Release 13 or better without any additional software or utilities from Avaya, as this utility will process either binary or ASCII output from the Avaya CMS.
 
 h2. Status
 
-This release is now in production use within Call Centers using the Avaya CMS.  The utility successfully and reliably imports the data provided by the Avaya CMS ECHI into various databases, including Oracle and MySQL.  This provides the repository of call segments that may then be used to provide detailed Cradle to Grave reporting for the call center.
+This release is now in production use within Call Centers using the Avaya CMS.  The utility successfully and reliably imports the data provided by the Avaya CMS ECHI into various databases, including Microsoft Sqlserver, Oracle and MySQL.  This provides the repository of call segments that may then be used to provide detailed Cradle to Grave reporting for the call center.
 
 
 h2. Features
 
 The utility provides the following capabilities:
@@ -38,11 +36,15 @@
 ## echi_splits - stores data from the split.dat file
 ## echi_trunk_groups - stores data from the tkgrp.dat file
 ## echi_vdns - stores data from the vdn.dat file
 ## echi_vectors - stores data from the vector.dat file
 
+h2. What ECHI-Converter is not
 
+	# A reporting engine
+	# A set of database maintenance scripts
+	
 h2. Requirements
 
 	# "Ruby v1.8.6+":http://www.ruby-lang.org/
 	# "Rubygems v1.0.1+":http://www.rubygems.org/ 
 	# "ActiveRecord v1.15.3+":http://activerecord.rubyforge.org/
@@ -50,11 +52,13 @@
 	# "Daemons v1.0.7+":http://daemons.rubyforge.org/
 	# "FasterCSV v1.2.0+":http://fastercsv.rubyforge.org/
 	# "Rake v0.7.3+":http://rake.rubyforge.org/
 	# "UUIDTools v1.0.1+":http://sporkmonger.com/projects/uuidtools/
 	# "Win32-service v.0.5.x - *ONLY* - ":http://win32utils.rubyforge.org/ (Manual install for Windows only)
+	## A release will come out to support v0.6.x in the future, as that version of Win32-service is not backward compatible
 	# "Hoe v1.2.2+":http://rubyforge.org/projects/seattlerb/
+	# Avaya CMS ECHI Release 12+ enabled and configured to send to an FTP server
 
 
 h2. Installing
 
 <pre syntax="ruby">sudo gem install echi-converter</pre>
@@ -129,24 +133,49 @@
 
 While the use of Ruby allows for operation on a multitude of platforms, these are the platforms that have actually been tested on.  If you have success running on other platforms, please feel free to provide details on the Google Group.
 
 h4. Operating Systems
 
-POSIX, Windows XP SP2, Windows 2000 and Windows 2003.
+# POSIX
+# Windows XP SP2
+# Windows 2000
+# Windows 2003.
 
+h4. Databases
+
+# MySQL
+# Microsoft Sqlserver
+# DB2
+# Sqlite3
+# Postgres
+
+# Oracle (Currently automated table generation with migrations not supported. One must create their own schema following the Avaya documentation, and then the ECHI-Converter will run thereafter. Future Oracle Migrations support is planned. A further description and work around example may be found "here":http://rubyforge.org/tracker/index.php?func=detail&aid=21295&group_id=4110&atid=15802.)
+
 h4. FTP Servers
 
-VSFTP and Windows 2003/XP FTP Servers.
+# VSFTP 
+# Windows 2003/XP FTP Servers (When using a Windows FTP server, you must configure the FTP server to provide a UNIX directory listing format.)
 
+h2. Related Avaya Documentation for ECHI
+
+# "Avaya Call Management System Release 14 External Call History Interface":http://support.avaya.com/elmodocs2/cms/R14/ECHI.pdf
+# "Avaya Call Management System Release 13 External Call History Interface":http://support.avaya.com/elmodocs2/cms_r13_1/07-300737_ECHI.pdf
+
 h2. Screencast
 
 You may view the screencast on howto install and use the ECHI-Converter "here":http://www.screencast.com/t/lQQkIVkUZMr.
 
 h2. Forum
 
+Please report questions here:
+
 "Google Groups - ECHI Converter":http://groups.google.com/group/echi-converter
 
+Please report bugs here:
+
+"Ruby Forge Bug Tracker - ECHI Converter":http://rubyforge.org/tracker/?atid=15802&group_id=4110&func=browse
+
 h2. How to submit patches
 
 Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
 
 The trunk repository is <code>svn://rubyforge.org/var/svn/echi-converter/trunk</code> for anonymous access.
@@ -160,6 +189,6 @@
 Comments are welcome. Send an email to "jason [at] goecke.net":mailto:jason@goecke.net.
 
 h2. Other Recommended Open Source Projects
 
 # Asterisk -  is the world's leading open source PBXi, telephony engine, and telephony applications toolkit, link "here.":http://www.asterisk.org
-# Adhersion - is an open-source, unconventional voice framework that ties technologies together neatly, link "here.":http://www.adhearsion.com
+# Adhearsion - is an open-source, unconventional voice framework that ties technologies together neatly, link "here.":http://www.adhearsion.com
\ No newline at end of file