FS/FS/cdr/broadsoft.pm

   1 package FS::cdr::broadsoft;
   2
   3 use strict;
   4 use base qw( FS::cdr );
   5 use vars qw( %info );
   6 use FS::cdr qw( _cdr_date_parser_maker _cdr_min_parser_maker );
   7
   8 %info = (
   9   'name'          => 'Broadsoft',
  10   'weight'        => 500,
  11   'header'        => 1,     #0 default, set to 1 to ignore the first line, or
  12                             # to higher numbers to ignore that number of lines
  13   'type'          => 'csv', #csv (default), fixedlength or xls
  14   'sep_char'      => ',',   #for csv, defaults to ,
  15   'disabled'      => 0,     #0 default, set to 1 to disable
  16
  17   #listref of what to do with each field from the CDR, in order
  18   'import_fields' => [
  19
  20     skip(2),
  21     sub { my($cdr, $data, $conf, $param) = @_;
  22           $param->{skiprow} = 1 if lc($data) ne 'normal';
  23           '' },                                   #  3: type
  24
  25     skip(2),
  26     'dcontext',                                   #  6: direction
  27     trim('src'),                                  #  7: callingNumber
  28     skip(1),
  29     trim('dst'),                                  #  9: calledNumber
  30
  31     _cdr_date_parser_maker('startdate'),          # 10: startTime
  32     skip(1),
  33     sub { my($cdr, $data) = @_;
  34           $cdr->disposition(
  35             lc($data) eq 'yes' ?
  36             'ANSWERED' : 'NO ANSWER') },          # 12: answerIndicator
  37     _cdr_date_parser_maker('answerdate'),         # 13: answerTime
  38     _cdr_date_parser_maker('enddate'),            # 14: releaseTime
  39     skip(17),
  40     sub { my($cdr, $accountcode) = @_;
  41     if ($cdr->is_tollfree){
  42         my $dst = substr($cdr->dst,0,32);
  43         $cdr->set('accountcode', $dst);
  44     } else {
  45         $cdr->set('accountcode', $accountcode);
  46     }},
  47   ],
  48
  49 );
  50
  51 sub trim {
  52   my $fieldname = shift;
  53   return sub {
  54     my($cdr, $data) = @_;
  55     $data =~ s/^\+1//;
  56     $cdr->$fieldname($data);
  57     ''
  58   }
  59 }
  60
  61 sub skip {
  62   map { undef } (1..$_[0]);
  63 }
  64
  65 1;
  66
  67 __END__
  68
  69 list of freeside CDR fields, useful ones marked with *
  70
  71            acctid - primary key
  72     *[1]   calldate - Call timestamp (SQL timestamp)
  73            clid - Caller*ID with text
  74 7   *      src - Caller*ID number / Source number
  75 9   *      dst - Destination extension
  76            dcontext - Destination context
  77            channel - Channel used
  78            dstchannel - Destination channel if appropriate
  79            lastapp - Last application if appropriate
  80            lastdata - Last application data
  81 10  *      startdate - Start of call (UNIX-style integer timestamp)
  82 13         answerdate - Answer time of call (UNIX-style integer timestamp)
  83 14  *      enddate - End time of call (UNIX-style integer timestamp)
  84     *      duration - Total time in system, in seconds
  85     *      billsec - Total time call is up, in seconds
  86 12  *[2]   disposition - What happened to the call: ANSWERED, NO ANSWER, BUSY
  87            amaflags - What flags to use: BILL, IGNORE etc, specified on a per
  88            channel basis like accountcode.
  89 4   *[3]   accountcode - CDR account number to use: account
  90            uniqueid - Unique channel identifier
  91            userfield - CDR user-defined field
  92            cdr_type - CDR type - see FS::cdr_type (Usage = 1, S&E = 7, OC&C = 8)
  93     *[4]   charged_party - Service number to be billed
  94            upstream_currency - Wholesale currency from upstream
  95     *[5]   upstream_price - Wholesale price from upstream
  96            upstream_rateplanid - Upstream rate plan ID
  97            rated_price - Rated (or re-rated) price
  98            distance - km (need units field?)
  99            islocal - Local - 1, Non Local = 0
 100     *[6]   calltypenum - Type of call - see FS::cdr_calltype
 101            description - Description (cdr_type 7&8 only) (used for
 102            cust_bill_pkg.itemdesc)
 103            quantity - Number of items (cdr_type 7&8 only)
 104            carrierid - Upstream Carrier ID (see FS::cdr_carrier)
 105            upstream_rateid - Upstream Rate ID
 106            svcnum - Link to customer service (see FS::cust_svc)
 107            freesidestatus - NULL, done (or something)
 108
 109 [1] Auto-populated from startdate if not present
 110 [2] Package options available to ignore calls without a specific disposition
 111 [3] When using 'cdr-charged_party-accountcode' config
 112 [4] Auto-populated from src (normal calls) or dst (toll free calls) if not present
 113 [5] When using 'upstream_simple' rating method.
 114 [6] Set to usage class classnum when using pre-rated CDRs and usage class-based
 115     taxation (local/intrastate/interstate/international)