echi-converter 0.3.3 → 0.3.4

data/History.txt

@@ -133,4 +133,25 @@
   * Added error traps for ECHI_LOGS
 * Bug fix(es):  
   * Fixed a bug where the utility was not properly deleting the files from the ftp server
-  * Fixed a bug for the pco schema usage changing the echi_log column processed_at to processedat via the 005_change_log_processedat_name migration
+  * Fixed a bug for the pco schema usage changing the echi_log column processed_at to processedat via the 005_change_log_processedat_name migration
+
+== 0.3.4 2007-11-TBD
+
+* Major enhancement(s):
+* Minor enhancement(s):
+  * Added a database test script to examples/db_connect_test.rb
+  * Set the default ftp port in application.yml to 21
+  * Properly report that the database has been initialized at the start of processing as opposed to a successful connection
+  * Encapsulate the ASCII/BINARY database transactions in Begin/Rescue clauses to report on additional database issues that might arise
+  * Changed the schema YML references to 'echi_records' from 'fields' in order to use that file to store additional database table definitions
+  * Changed the default databse name to 'echi' in database.yml
+  * Added 006_create_echi_aux_reasons.rb, 007_create_echi_cwcs.rb and 008_create_echi_vdns.rb migrations following the same format as 001_create_echi_records.rb
+  * Startup sequence now shows which settings were used
+  * Changed the application.yml setting of echi_update_agent_data to echi_process_dat_files
+  * Refactored logging mechanism
+  * Added support for additional '.dat' files including aux_rsn.dat, cwc.dat and vdn.dat
+  * Added utf8 encoding option to config/database.yml
+  * Refactored FTP management into a new class
+  * FTP now supports setting an alternative port by setting 'echi_port' in the application.yml file
+  * Added option in config/application.yml, 'max_ftp_sessions', to allow for multiple ftp sessions to be used to increase ftp interaction performance
+* Bug fix(es):  

data/Manifest.txt

@@ -10,6 +10,7 @@ lib/database_presence.rb
 lib/main.rb
 lib/main_win32.rb
 lib/echi-converter.rb
+lib/ftp_fetcher.rb
 scripts/txt2html
 setup.rb
 test/test_echi-converter.rb
@@ -31,8 +32,12 @@ db/migrate/002_create_echi_logs.rb
 db/migrate/003_create_echi_agents.rb
 db/migrate/004_change_log_name_size.rb
 db/migrate/005_change_log_processedat_name.rb
+db/migrate/006_create_echi_aux_reasons.rb
+db/migrate/007_create_echi_cwcs.rb
+db/migrate/008_create_echi_vdns.rb
 bin/echi-converter
 examples/extended_version12/chr0003
 examples/extended_version12/chr0003.txt
 examples/schemas/oracle_echi.sql
 examples/ascii_csv/chr5500.123
+examples/db_connect_test.rb

data/config/application.yml

@@ -2,7 +2,7 @@
 
 #Connection details for the Avaya CMS/ECHI host
 echi_host:      localhost
-echi_port:      22
+echi_port:      21
 echi_username:  anonymous
 echi_password:  
 echi_connect_type:  ftp #only ftp supported now, possible for ssh in the future
@@ -12,14 +12,19 @@ echi_ftp_delete:  Y #to not delete the files off of the FTP server set to N, Y t
 echi_schema: extended_version13.yml
 echi_format: BINARY #valid settings are ASCII or BINARY
 echi_process_log: Y #valid is Y/N to turn it on or off
-echi_update_agent_data:  N #Insert data in the 'echi_agents' table with the 'agname.dat' file, and update regularly (not available when 'pco_process' set to 'Y')
-echi_update_agent_data_freq:  24 #Number of hours to wait before updating the 'echi_agents' table
+echi_process_dat_files: N #Insert additional tables with data from the '.dat' files, and update regularly (not available when 'pco_process' set to 'Y')
+#Filenames of the dat files
+echi_agent_dat: agname.dat
+echi_aux_rsn_dat: aux_rsn.dat
+echi_cwc_dat: cwc.dat
+echi_vdn_dat: vdn.dat
 
 #Currently only ftp supported, but may want to add SSH/SFTP later
 echi_xfer_type: ftp
 
 #How frequently to fetch records off of the Avaya CMS ftp server
 fetch_interval: 60  #in seconds
+max_ftp_sessions: 2 #Number of simultaneous ftp connections to use
 
 #Whether or not to insert into a database, into a csv file or both
 export_type:    database
@@ -44,4 +49,4 @@ smtp_server: smtp.yourdomain.com
 smtp_port: 25
 
 #Special settings for a specific application database
-pco_process: N #Set to yes (Y) or no (N) if running with a PCO database
+pco_process: N #Set to Y (yes) to enable using the PCO database or to no N (no) if not using the PCO database

data/config/database.yml

@@ -1,6 +1,7 @@
 #Database connection configuration, uses Active Record from Ruby on Rails
 adapter: mysql
-database: echi_records
+database: echi
 username: root
 password:
-host: localhost
+host: localhost
+#encoding: utf8

data/config/extended_version12.yml

@@ -1,6 +1,6 @@
 #ECH File construct, order is important, as the application sequentially reads the file
 #Version 12 - Extended Schema
-fields:
+echi_records:
     - name: callid
       type: int
       length: 4
@@ -231,4 +231,52 @@ fields:
       length: 8
     - name: asaiuui
       type: str
-      length: 96
+      length: 96
+      
+#Agents table definition derived from agname.dat
+echi_agents:
+    - name: group_id
+      type: str
+      length: 255
+    - name: login_id
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#Aux Reasons table definition derived from aux_rsn.dat
+echi_aux_reasons:
+    - name: group_id
+      type: str
+      length: 255
+    - name: aux_reason
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+      
+#CWC definition derived from cwc.dat
+echi_cwcs:
+    - name: group_id
+      type: str
+      length: 255
+    - name: cwc
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#VDN definition derived from vdn.dat
+echi_vdns:
+  - name: group_id
+    type: str
+    length: 255
+  - name: vdn
+    type: str
+    length: 255
+  - name: name
+    type: str
+    length: 255

data/config/extended_version13.yml

@@ -1,6 +1,6 @@
 #ECH File construct, order is important, as the application sequentially reads the file
 #Version 13 - Extended Schema
-fields:
+echi_records:
     - name: callid
       type: int
       length: 4
@@ -231,4 +231,52 @@ fields:
       length: 8
     - name: asaiuui
       type: str
-      length: 96
+      length: 96
+      
+#Agents table definition derived from agname.dat
+echi_agents:
+    - name: group_id
+      type: str
+      length: 255
+    - name: login_id
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#Aux Reasons table definition derived from aux_rsn.dat
+echi_aux_reasons:
+    - name: group_id
+      type: str
+      length: 255
+    - name: aux_reason
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+      
+#CWC definition derived from cwc.dat
+echi_cwcs:
+    - name: group_id
+      type: str
+      length: 255
+    - name: cwc
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#VDN definition derived from vdn.dat
+echi_vdns:
+  - name: group_id
+    type: str
+    length: 255
+  - name: vdn
+    type: str
+    length: 255
+  - name: name
+    type: str
+    length: 255

data/config/install_files.yml

@@ -35,6 +35,9 @@ files_to_copy:
     - name: db/migrate/003_create_echi_agents.rb
     - name: db/migrate/004_change_log_name_size.rb
     - name: db/migrate/005_change_log_processedat_name.rb
+    - name: db/migrate/006_create_echi_aux_reasons.rb
+    - name: db/migrate/007_create_echi_cwcs.rb
+    - name: db/migrate/008_create_echi_vdns.rb
     - name: examples/extended_version12/chr0003
     - name: examples/extended_version12/chr0003.txt
     - name: examples/ascii_csv/chr5500.123
@@ -44,7 +47,9 @@ files_to_copy:
     - name: lib/main.rb
     - name: lib/main_win32.rb
     - name: lib/echi-converter/version.rb
+    - name: lib/ftp_fetcher.rb
     - name: examples/schemas/oracle_echi.sql
+    - name: examples/db_connect_test.rb
     
 files_to_upgrade:
     - name: lib/database.rb
@@ -53,6 +58,10 @@ files_to_upgrade:
     - name: lib/main.rb
     - name: lib/main_win32.rb
     - name: lib/echi-converter/version.rb
+    - name: lib/ftp_fetcher.rb
     - name: db/migrate/003_create_echi_agents.rb
     - name: db/migrate/004_change_log_name_size.rb
     - name: db/migrate/005_change_log_processedat_name.rb
+    - name: db/migrate/006_create_echi_aux_reasons.rb
+    - name: db/migrate/007_create_echi_cwcs.rb
+    - name: db/migrate/008_create_echi_vdns.rb

data/config/standard_version12.yml

@@ -1,6 +1,6 @@
 #ECH File construct, order is important, as the application sequentially reads the file
 #Version 12 - Standard Schema
-fields:
+echi_records:
     - name: callid
       type: int
       length: 4
@@ -195,4 +195,52 @@ fields:
       length: 17
     - name: cwcs4
       type: str
-      length: 17
+      length: 17
+      
+#Agents table definition derived from agname.dat
+echi_agents:
+    - name: group_id
+      type: str
+      length: 255
+    - name: login_id
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#Aux Reasons table definition derived from aux_rsn.dat
+echi_aux_reasons:
+    - name: group_id
+      type: str
+      length: 255
+    - name: aux_reason
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+      
+#CWC definition derived from cwc.dat
+echi_cwcs:
+    - name: group_id
+      type: str
+      length: 255
+    - name: cwc
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#VDN definition derived from vdn.dat
+echi_vdns:
+  - name: group_id
+    type: str
+    length: 255
+  - name: vdn
+    type: str
+    length: 255
+  - name: name
+    type: str
+    length: 255

data/config/standard_version13.yml

@@ -1,6 +1,6 @@
 #ECH File construct, order is important, as the application sequentially reads the file
 #Version 13 - Standard Schema
-fields:
+echi_records:
     - name: callid
       type: int
       length: 4
@@ -195,4 +195,52 @@ fields:
       length: 17
     - name: cwcs4
       type: str
-      length: 17
+      length: 17
+      
+#Agents table definition derived from agname.dat
+echi_agents:
+    - name: group_id
+      type: str
+      length: 255
+    - name: login_id
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#Aux Reasons table definition derived from aux_rsn.dat
+echi_aux_reasons:
+    - name: group_id
+      type: str
+      length: 255
+    - name: aux_reason
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+      
+#CWC definition derived from cwc.dat
+echi_cwcs:
+    - name: group_id
+      type: str
+      length: 255
+    - name: cwc
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#VDN definition derived from vdn.dat
+echi_vdns:
+  - name: group_id
+    type: str
+    length: 255
+  - name: vdn
+    type: str
+    length: 255
+  - name: name
+    type: str
+    length: 255

data/db/migrate/001_create_echi_records.rb

@@ -2,7 +2,7 @@ class CreateEchiRecords < ActiveRecord::Migration
   def self.up
     #We create the table from the one defined in the application.yml file
     create_table "echi_records", :force => true do |t|
-      @@echi_schema["fields"].each do | field |
+      @@echi_schema["echi_records"].each do | field |
         case field["type"]
         when 'int'
           t.column field["name"], :integer, :limit => field["length"], :precision => field["length"], :scale => 0

data/db/migrate/003_create_echi_agents.rb

@@ -1,9 +1,21 @@
 class CreateEchiAgents < ActiveRecord::Migration
   def self.up
+    #We create the table from the one defined in the application.yml file
     create_table "echi_agents", :force => true do |t|
-      t.column "group_id", :string
-      t.column "login_id", :string
-      t.column "name", :string
+      @@echi_schema["echi_agents"].each do | field |
+        case field["type"]
+        when 'int'
+          t.column field["name"], :integer, :limit => field["length"], :precision => field["length"], :scale => 0
+        when 'str'
+          t.column field["name"], :string, :limit => field["length"]
+        when 'datetime'
+          t.column field["name"], :datetime
+        when 'bool'
+          t.column field["name"], :string, :limit => 1
+        when 'bool_int'
+          t.column field["name"], :string, :limit => 1
+        end
+      end
     end
     add_index "echi_agents", "login_id"
   end

data/db/migrate/006_create_echi_aux_reasons.rb

@@ -0,0 +1,27 @@
+class CreateEchiAuxReasons < ActiveRecord::Migration
+  def self.up
+    #We create the table from the one defined in the application.yml file
+    create_table "echi_aux_reasons", :force => true do |t|
+      @@echi_schema["echi_aux_reasons"].each do | field |
+        case field["type"]
+        when 'int'
+          t.column field["name"], :integer, :limit => field["length"], :precision => field["length"], :scale => 0
+        when 'str'
+          t.column field["name"], :string, :limit => field["length"]
+        when 'datetime'
+          t.column field["name"], :datetime
+        when 'bool'
+          t.column field["name"], :string, :limit => 1
+        when 'bool_int'
+          t.column field["name"], :string, :limit => 1
+        end
+      end
+    end
+    add_index "echi_aux_reasons", "aux_reason"
+  end
+
+  def self.down
+    remove_index "echi_aux_reasons", "aux_reason"
+    drop_table "echi_aux_reasons"
+  end
+end

data/db/migrate/007_create_echi_cwcs.rb

@@ -0,0 +1,27 @@
+class CreateEchiCwcs < ActiveRecord::Migration
+  def self.up
+    #We create the table from the one defined in the application.yml file
+    create_table "echi_cwcs", :force => true do |t|
+      @@echi_schema["echi_cwcs"].each do | field |
+        case field["type"]
+        when 'int'
+          t.column field["name"], :integer, :limit => field["length"], :precision => field["length"], :scale => 0
+        when 'str'
+          t.column field["name"], :string, :limit => field["length"]
+        when 'datetime'
+          t.column field["name"], :datetime
+        when 'bool'
+          t.column field["name"], :string, :limit => 1
+        when 'bool_int'
+          t.column field["name"], :string, :limit => 1
+        end
+      end
+    end
+    add_index "echi_cwcs", "cwc"
+  end
+
+  def self.down
+    remove_index "echi_cwcs", "cwc"
+    drop_table "echi_cwcs"
+  end
+end