Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust pkg/Import"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
Line 30: Line 30:
 
; process_batch_import
 
; process_batch_import
 
:Load a batch import as a queued JSRPC job
 
:Load a batch import as a queued JSRPC job
; batch_import<code>
+
; batch_import
    my $billtime = time;
 
    my %cust_pkg = ( pkgpart => $pkgpart );
 
    my %svc_x = ();
 
    foreach my $field ( @fields ) {
 
 
      if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
 
 
        #$cust_pkg{$1} = parse_datetime( shift @$columns );
 
        if ( $1 eq 'pkgpart' ) {
 
          $cust_pkg{$1} = shift @columns;
 
        } elsif ( $1 eq 'setup' ) {
 
          $billtime = parse_datetime(shift @columns);
 
        } else {
 
          $cust_pkg{$1} = parse_datetime( shift @columns );
 
        }
 
 
      } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
 
 
        $svc_x{$1} = shift @columns;
 
 
      } elsif ( $field =~ /^svc_external\.(id|title)$/ ) {
 
 
        $svc_x{$1} = shift @columns;
 
 
      } elsif ( $field =~ /^svc_phone\.(countrycode|phonenum|sip_password|pin)$/ ) {
 
        $svc_x{$1} = shift @columns;
 
     
 
      } else {
 
 
        #refnum interception
 
        if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
 
 
          my $referral = $columns[0];
 
          my %hash = ( 'referral' => $referral,
 
                      'agentnum' => $agentnum,
 
                      'disabled' => '&#39;,
 
                    );
 
 
          my $part_referral = qsearchs('part_referral', \%hash )
 
                              || new FS::part_referral \%hash;
 
 
          unless ( $part_referral->refnum ) {
 
            my $error = $part_referral->insert;
 
            if ( $error ) {
 
              $dbh->rollback if $oldAutoCommit;
 
              return "can't auto-insert advertising source: $referral: $error";
 
            }
 
          }
 
 
          $columns[0] = $part_referral->refnum;
 
        }
 
 
        my $value = shift @columns;
 
        $cust_main{$field} = $value if length($value);
 
      }
 
    }
 
 
    $cust_main{'payby'} = 'CARD'
 
      if defined $cust_main{'payinfo'}
 
      && length  $cust_main{'payinfo'};
 
 
    my $invoicing_list = $cust_main{'invoicing_list'}
 
                          ? [ delete $cust_main{'invoicing_list'} ]
 
                          : [];
 
 
    my $cust_main = new FS::cust_main ( \%cust_main );
 
 
    use Tie::RefHash;
 
    tie my %hash, 'Tie::RefHash'; #this part is important
 
 
    if ( $cust_pkg{'pkgpart'} ) {
 
      my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
 
 
      my @svc_x = ();
 
      my $svcdb = '&#39;;
 
      if ( $svc_x{'username'} ) {
 
        $svcdb = 'svc_acct';
 
      } elsif ( $svc_x{'id'} || $svc_x{'title'} ) {
 
        $svcdb = 'svc_external';
 
      }
 
 
      my $svc_phone = '&#39;;
 
      if ( $svc_x{'countrycode'} || $svc_x{'phonenum'} ) {
 
        $svc_phone = FS::svc_phone->new( {
 
          map { $_ => delete($svc_x{$_}) }
 
              qw( countrycode phonenum sip_password pin)
 
        } );
 
      }
 
 
      if ( $svcdb || $svc_phone ) {
 
        my $part_pkg = $cust_pkg->part_pkg;
 
        unless ( $part_pkg ) {
 
          $dbh->rollback if $oldAutoCommit;
 
          return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
 
        }
 
        if ( $svcdb ) {
 
          $svc_x{svcpart} = $part_pkg->svcpart_unique_svcdb( $svcdb );
 
          my $class = "FS::$svcdb";
 
          push @svc_x, $class->new( \%svc_x );
 
        }
 
        if ( $svc_phone ) {
 
          $svc_phone->svcpart( $part_pkg->svcpart_unique_svcdb('svc_phone') );
 
          push @svc_x, $svc_phone;
 
        }
 
      }
 
 
      $hash{$cust_pkg} = \@svc_x;
 
    }
 
 
    my $error = $cust_main->insert( \%hash, $invoicing_list );
 
 
    if ( $error ) {
 
      $dbh->rollback if $oldAutoCommit;
 
      return "can't insert customer". ( $line ? " for $line" : '&#39; ). ": $error";
 
    }
 
 
    if ( $format eq 'simple' ) {
 
 
      #false laziness w/bill.cgi
 
      $error = $cust_main->bill( 'time' => $billtime );
 
      if ( $error ) {
 
        $dbh->rollback if $oldAutoCommit;
 
        return "can't bill customer for $line: $error";
 
      }
 
 
 
      $error = $cust_main->apply_payments_and_credits;
 
      if ( $error ) {
 
        $dbh->rollback if $oldAutoCommit;
 
        return "can't bill customer for $line: $error";
 
      }
 
 
      $error = $cust_main->collect();
 
      if ( $error ) {
 
        $dbh->rollback if $oldAutoCommit;
 
        return "can't collect customer for $line: $error";
 
      }
 
 
    }
 
 
    $row++;
 
 
    if ( $job && time - $min_sec > $last ) { #progress bar
 
      $job->update_statustext( int(100 * $row / $count) );
 
      $last = time;
 
    }
 
 
  }
 
 
  $dbh->commit or die $dbh->errstr if $oldAutoCommit;;
 
 
  return "Empty file!" unless $row;
 
 
  '&#39;; #no error
 
</code>
 
 
 
:}
 
 
 
 
==BUGS==
 
==BUGS==
 
Not enough documentation.
 
Not enough documentation.
Line 197: Line 40:
 
Hey! '''The above document had some coding errors, which are explained below:'''
 
Hey! '''The above document had some coding errors, which are explained below:'''
  
; Around line 55&#58;
+
; Around line 53&#58;
 
:'=item' outside of any '=over'
 
:'=item' outside of any '=over'
; Around line 401&#58;
+
; Around line 240&#58;
 
:You forgot a '=back' before '=head1'
 
:You forgot a '=back' before '=head1'

Revision as of 12:05, 30 March 2015

NAME

FS::cust_pkg::Import - Batch customer importing

SYNOPSIS

 use FS::cust_pkg::Import;

 #import
 FS::cust_pkg::Import::batch_import( {
   file      => $file,      #filename
   type      => $type,      #csv or xls
   format    => $format,    #extended, extended-plus_company, svc_external,
                            # or svc_external_svc_phone
   agentnum  => $agentnum,
   job       => $job,       #optional job queue job, for progressbar updates
   pkgbatch  => $pkgbatch, #optional batch unique identifier
 } );
 die $error if $error;

 #ajax helper
 use FS::UI::Web::JSRPC;
 my $server =
   new FS::UI::Web::JSRPC 'FS::cust_pkg::Import::process_batch_import', $cgi;
 print $server->process;

DESCRIPTION

Batch package importing.

SUBROUTINES

process_batch_import
Load a batch import as a queued JSRPC job
batch_import

BUGS

Not enough documentation.

SEE ALSO

FS::cust_main, FS::cust_pkg, FS::svc_acct, FS::svc_external, FS::svc_phone

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 53:
'=item' outside of any '=over'
Around line 240:
You forgot a '=back' before '=head1'