echi-converter 0.3.6 → 0.3.7

data/History.txt

@@ -169,4 +169,15 @@
 * Minor enhancement(s):
   * Added a Signal.trap on interrupt to echi-converter executable for a more graceful shutdown 
 * Bug fix(es):  
-  * The bit operators in the boolean fields are now processed properly for BINARY file types (found by user Chun Lim)
+  * The bit operators in the boolean fields are now processed properly for BINARY file types (found by user Chun Lim)
+
+== 0.3.7 2008-03-25
+
+* Major enhancement(s):
+* Minor enhancement(s):
+  * Added support for the dat files: acd.dat, split.cat, tkgrp.dat and vector.dat
+  * Added support for turning email notifications on and off - FR#18889
+  * Changed the default logging in application.yml to 'NONE' from 'DEBUG'
+  * Added standard_version14.yml and extended_version14.yml
+* Bug fix(es):  
+  * Will now archive 0 length files and not stop the Windows Service - Bug#18888

data/Manifest.txt

@@ -24,8 +24,10 @@ config/application.yml
 config/database.yml
 config/extended_version12.yml
 config/extended_version13.yml
+config/extended_version14.yml
 config/standard_version12.yml
 config/standard_version13.yml
+config/standard_version14.yml
 config/install_files.yml
 db/migrate/001_create_echi_records.rb
 db/migrate/002_create_echi_logs.rb
@@ -35,6 +37,10 @@ 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
+db/migrate/009_create_echi_acds.rb
+db/migrate/010_create_echi_splits.rb
+db/migrate/011_create_echi_trunk_groups.rb
+db/migrate/012_create_echi_vectors.rb
 bin/echi-converter
 examples/extended_version12/chr0003
 examples/extended_version12/chr0003.txt

data/README.txt

@@ -1,26 +1,48 @@
-README for echi_converter
-==========================
-ECHI Converter - The Binary to ASCII converter for Avaya CMS External Call History files
+= blah
 
---- background ---
+* http://echi-converter.rubyforge.org
 
-See more info on the Avaya ECHI format here (note, these overviews are version specific):
+== DESCRIPTION:
 
-http://support.avaya.com/elmodocs2/cms/R12/ECHI.pdf
+Please refer to http://echi-converter.rubyforge.org
 
---- command ---
+== FEATURES/PROBLEMS:
 
-Usage: 
+* TBD
 
-# echi-converter create myproject - create the local project to run the ECHI converter from
-# echi-converter upgrade myproject - location of project to upgrade after a new gem is installed
+== SYNOPSIS:
 
-# echi-converter run myproject - Run the ECHI converter interactively from the location given
-# echi-converter start myproject - Start the ECHI converter in daemon mode from the location given
-# echi-converter stop myproject - Stop the ECHI converter daemon
-# echi-converter restart myproject - Restart the ECHI converter 
-# echi-converter zap myrpoject - If there has been an unexpected close and the system still thinks the converter is running, clean up the pid files
+  Please refer to http://echi-converter.rubyforge.org
 
---- overview ---
+== REQUIREMENTS:
 
-More to come...
+* TBD
+
+== INSTALL:
+
+* TBD
+
+== LICENSE:
+
+(LGPL)
+
+Copyright (c) 2008 Jason Goecke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/config/application.yml

@@ -6,7 +6,7 @@ echi_port:      21
 echi_username:  anonymous
 echi_password:  
 echi_connect_type:  ftp #only ftp supported now, possible for ssh/sftp in the future
-echi_ftp_directory:  #/Users/ftp/anonymous #If blank/nil, the system will not do a CD at the start
+echi_ftp_directory:  /Users/ftp/anonymous #If blank/nil, the system will not do a CD at the start
 echi_ftp_retry: 10
 echi_ftp_delete:  Y #to not delete the files off of the FTP server set to N, Y to delete the files
 echi_schema: extended_version13.yml
@@ -14,9 +14,13 @@ echi_format: BINARY #valid settings are ASCII or BINARY
 echi_process_log: Y #valid is Y/N to turn it on or off
 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_acd_dat: acd.dat
 echi_agent_dat: agname.dat
 echi_aux_rsn_dat: aux_rsn.dat
 echi_cwc_dat: cwc.dat
+echi_split_dat: split.dat
+echi_trunk_group_dat: tkgrp.dat
+echi_vector_dat: vector.dat
 echi_vdn_dat: vdn.dat
 
 #Currently only ftp supported, but may want to add SSH/SFTP later
@@ -26,7 +30,7 @@ echi_xfer_type: ftp
 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
+#Currently only database support, possible CSV in the future
 export_type:    database
 
 #Options are:
@@ -36,7 +40,7 @@ export_type:    database
     #INFO:	generic (useful) information about system operation
     #DEBUG:	low-level information for developers
     #NONE:  turn off logging
-log_level:  DEBUG
+log_level:  NONE
 #How many log files to create and the length before cycling through
 log_number: 10
 #The size of each individual log file
@@ -44,6 +48,7 @@ log_length: 10240000
 
 #Email address to send alerts to, specifically failures to connect to the DB or FTP servers
 #currently does not support an SMTP server that requires authentication
+send_email: true #Whether or not to send an email, true or false
 alert_email_address: youremail@yourdomain.com
 smtp_server: smtp.yourdomain.com
 smtp_port: 25

data/config/extended_version12.yml

@@ -232,7 +232,19 @@ echi_records:
     - name: asaiuui
       type: str
       length: 96
-      
+
+#ACD table definition derived from acd.dat
+echi_acds:
+    - name: acd_id
+      type: str
+      length: 255
+    - name: number
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+                  
 #Agents table definition derived from agname.dat
 echi_agents:
     - name: group_id
@@ -269,6 +281,30 @@ echi_cwcs:
       type: str
       length: 255
 
+#Split table definition derived from split.dat
+echi_splits:
+   - name: acd_number
+     type: str
+     length: 255
+   - name: number
+     type: str
+     length: 255
+   - name: name
+     type: str
+     length: 255
+     
+#Trunk Group table definition derived from tkgrp.dat
+echi_trunk_groups:
+   - name: acd_number
+     type: str
+     length: 255
+   - name: trunk_group
+     type: str
+     length: 255
+   - name: name
+     type: str
+     length: 255
+          
 #VDN definition derived from vdn.dat
 echi_vdns:
   - name: group_id
@@ -277,6 +313,18 @@ echi_vdns:
   - name: vdn
     type: str
     length: 255
+  - name: name
+    type: str
+    length: 255
+    
+#Vector definition derived from vector.dat
+echi_vectors:
+  - name: acd_number
+    type: str
+    length: 255
+  - name: number
+    type: str
+    length: 255
   - name: name
     type: str
     length: 255

data/config/extended_version13.yml

@@ -233,6 +233,18 @@ echi_records:
       type: str
       length: 96
       
+#ACD table definition derived from acd.dat
+echi_acds:
+    - name: acd_id
+      type: str
+      length: 255
+    - name: number
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
 #Agents table definition derived from agname.dat
 echi_agents:
     - name: group_id
@@ -256,7 +268,7 @@ echi_aux_reasons:
     - name: name
       type: str
       length: 255
-      
+
 #CWC definition derived from cwc.dat
 echi_cwcs:
     - name: group_id
@@ -269,14 +281,50 @@ echi_cwcs:
       type: str
       length: 255
 
+#Split table definition derived from split.dat
+echi_splits:
+    - name: acd_number
+      type: str
+      length: 255
+    - name: number
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#Trunk Group table definition derived from tkgrp.dat
+echi_trunk_groups:
+    - name: acd_number
+      type: str
+      length: 255
+    - name: trunk_group
+      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
+    - name: group_id
+      type: str
+      length: 255
+    - name: vdn
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+
+#Vector definition derived from vector.dat
+echi_vectors:
+    - name: acd_number
+      type: str
+      length: 255
+    - name: number
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255

data/config/extended_version14.yml

@@ -0,0 +1,330 @@
+#ECH File construct, order is important, as the application sequentially reads the file
+#Version 14 - Extended Schema
+echi_records:
+    - name: callid
+      type: int
+      length: 4
+    - name: acwtime
+      type: int
+      length: 4
+    - name: onholdtime
+      type: int
+      length: 4
+    - name: consulttime
+      type: int
+      length: 4
+    - name: disptime
+      type: int
+      length: 4
+    - name: duration
+      type: int
+      length: 4
+    - name: segstart
+      type: datetime
+      length: 4
+    - name: segstop
+      type: datetime
+      length: 4
+    - name: talktime
+      type: int
+      length: 4
+    - name: netintime
+      type: int
+      length: 4
+    - name: origholdtime
+      type: int
+      length: 4
+    - name: queuetime
+      type: int
+      length: 4
+    - name: ringtime
+      type: int
+      length: 4
+    - name: dispivector
+      type: int
+      length: 2
+    - name: dispsplit
+      type: int
+      length: 2
+    - name: firstivector
+      type: int
+      length: 2
+    - name: split1
+      type: int
+      length: 2
+    - name: split2
+      type: int
+      length: 2
+    - name: split3
+      type: int
+      length: 2
+    - name: trunkgroup
+      type: int
+      length: 2
+    - name: tklocid
+      type: int
+      length: 2
+    - name: origlocid
+      type: int
+      length: 2
+    - name: answerlocid
+      type: int
+      length: 2
+    - name: obslocid
+      type: int
+      length: 2
+    - name: uuilen
+      type: int
+      length: 2
+    - name: assist
+      type: bool
+      length: 1
+    - name: audiodifficulty
+      type: bool
+      length: 1
+    - name: conference
+      type: bool
+      length: 1
+    - name: daqueued
+      type: bool
+      length: 1
+    - name: holdabn
+      type: bool
+      length: 1
+    - name: malicious
+      type: bool
+      length: 1
+    - name: observingcall
+      type: bool
+      length: 1
+    - name: transferred
+      type: bool
+      length: 1
+    - name: agentreleased
+      type: boolint
+      length: 1
+    - name: acdnum
+      type: int
+      length: 1
+    - name: calldisp
+      type: int
+      length: 1
+    - name: disppriority
+      type: int
+      length: 1
+    - name: holds
+      type: int
+      length: 1
+    - name: segment
+      type: int
+      length: 1
+    - name: ansreason
+      type: int
+      length: 1
+    - name: origreason
+      type: int
+      length: 1
+    - name: dispsklevel
+      type: int
+      length: 1
+    - name: events0
+      type: int
+      length: 1
+    - name: events1
+      type: int
+      length: 1
+    - name: events2
+      type: int
+      length: 1
+    - name: events3
+      type: int
+      length: 1
+    - name: events4
+      type: int
+      length: 1
+    - name: events5
+      type: int
+      length: 1
+    - name: events6
+      type: int
+      length: 1
+    - name: events7
+      type: int
+      length: 1
+    - name: events8
+      type: int
+      length: 1
+    - name: ucid
+      type: str
+      length: 21
+    - name: dispvdn
+      type: str
+      length: 8
+    - name: eqloc
+      type: str
+      length: 10
+    - name: firstvdn 
+      type: str
+      length: 8
+    - name: origlogid
+      type: str
+      length: 10
+    - name: anslogid
+      type: str
+      length: 10
+    - name: lastobserver
+      type: str
+      length: 10
+    - name: dialednumber
+      type: str
+      length: 25
+    - name: callingparty
+      type: str
+      length: 13
+    - name: collectdigits
+      type: str
+      length: 17
+    - name: cwcdigits
+      type: str
+      length: 17
+    - name: callingII
+      type: str
+      length: 3
+    - name: cwcs0
+      type: str
+      length: 17
+    - name: cwcs1
+      type: str
+      length: 17
+    - name: cwcs2
+      type: str
+      length: 17
+    - name: cwcs3
+      type: str
+      length: 17
+    - name: cwcs4
+      type: str
+      length: 17
+    - name: vdn2
+      type: str
+      length: 8
+    - name: vdn3
+      type: str
+      length: 8
+    - name: vdn4
+      type: str
+      length: 8
+    - name: vdn5
+      type: str
+      length: 8
+    - name: vdn6
+      type: str
+      length: 8
+    - name: vdn7
+      type: str
+      length: 8
+    - name: vdn8
+      type: str
+      length: 8
+    - name: vdn9
+      type: str
+      length: 8
+    - name: asaiuui
+      type: str
+      length: 96
+
+#ACD table definition derived from acd.dat
+echi_acds:
+    - name: acd_id
+      type: str
+      length: 255
+    - name: number
+      type: str
+      length: 255
+    - name: name
+      type: str
+      length: 255
+                  
+#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
+
+#Split table definition derived from split.dat
+echi_splits:
+   - name: acd_number
+     type: str
+     length: 255
+   - name: number
+     type: str
+     length: 255
+   - name: name
+     type: str
+     length: 255
+     
+#Trunk Group table definition derived from tkgrp.dat
+echi_trunk_groups:
+   - name: acd_number
+     type: str
+     length: 255
+   - name: trunk_group
+     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
+    
+#Vector definition derived from vector.dat
+echi_vectors:
+  - name: acd_number
+    type: str
+    length: 255
+  - name: number
+    type: str
+    length: 255
+  - name: name
+    type: str
+    length: 255