continue sales person work: customer and package selection, commissions, reporting...
authorIvan Kohler <ivan@freeside.biz>
Sun, 18 Aug 2013 23:09:39 +0000 (16:09 -0700)
committerIvan Kohler <ivan@freeside.biz>
Sun, 18 Aug 2013 23:09:39 +0000 (16:09 -0700)
13 files changed:
FS/FS.pm
FS/FS/Mason.pm
FS/FS/Schema.pm
FS/FS/agent_pkg_class.pm
FS/FS/sales_pkg_class.pm [new file with mode: 0644]
FS/MANIFEST
FS/t/sales_pkg_class.t [new file with mode: 0644]
httemplate/browse/sales.html
httemplate/edit/agent.cgi
httemplate/edit/process/sales.html
httemplate/edit/sales.html
httemplate/elements/table-commissions.html [new file with mode: 0644]
httemplate/search/agent_commission.html

index 9ba5ba1..3484444 100644 (file)
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -276,6 +276,8 @@ L<FS::usage_class> - Usage class class
 
 L<FS::sales> - Sales person class
 
+L<FS::sales_pkg_class> - Sales person package class commission class
+
 L<FS::agent> - Agent (reseller) class
 
 L<FS::agent_currency> - Agent (reseller) currency class
index 7993048..5cecefd 100644 (file)
@@ -351,6 +351,7 @@ if ( -e $addl_handler_use_file ) {
   use FS::vend_bill;
   use FS::vend_pay;
   use FS::vend_bill_pay;
+  use FS::sales_pkg_class;
   # Sammath Naur
 
   if ( $FS::Mason::addl_handler_use ) {
index 2e9a10a..6fca62e 100644 (file)
@@ -525,6 +525,17 @@ sub tables_hashref {
       'index' => [ ['typenum'] ],
     },
 
+    'agent_currency' => {
+      'columns' => [
+        'agentcurrencynum', 'serial', '', '', '', '',
+        'agentnum',            'int', '', '', '', '',
+        'currency',           'char', '',  3, '', '',
+      ],
+      'primary_key' => 'agentcurrencynum',
+      'unique'      => [],
+      'index'       => [ ['agentnum'] ],
+    },
+
     'sales' => {
       'columns' => [
         'salesnum',          'serial',    '',       '', '', '', 
@@ -537,15 +548,17 @@ sub tables_hashref {
       'index' => [ ['salesnum'], ['disabled'] ],
     },
 
-    'agent_currency' => {
+    'sales_pkg_class' => {
       'columns' => [
-        'agentcurrencynum', 'serial', '', '', '', '',
-        'agentnum',            'int', '', '', '', '',
-        'currency',           'char', '',  3, '', '',
+        'salespkgclassnum',    'serial',     '',    '', '', '',
+        'salesnum',               'int',     '',    '', '', '',
+        'classnum',               'int', 'NULL',    '', '', '',
+        'commission_percent', 'decimal',     '', '7,4', '', '',
+        'commission_duration',    'int', 'NULL',    '', '', '',
       ],
-      'primary_key' => 'agentcurrencynum',
-      'unique'      => [],
-      'index'       => [ ['agentnum'] ],
+      'primary_key' => 'salespkgclassnum',
+      'unique'      => [ [ 'salesnum', 'classnum' ], ],
+      'index'       => [],
     },
 
     'cust_attachment' => {
index 1683c1a..5c5c3f7 100644 (file)
@@ -1,8 +1,10 @@
 package FS::agent_pkg_class;
+use base qw( FS::Record );
 
 use strict;
-use base qw( FS::Record );
-use FS::Record qw( qsearch qsearchs );
+#use FS::Record qw( qsearch qsearchs );
+use FS::agent;
+use FS::pkg_class;
 
 =head1 NAME
 
@@ -25,7 +27,7 @@ FS::agent_pkg_class - Object methods for agent_pkg_class records
 
 =head1 DESCRIPTION
 
-An FS::agent_pkg_class object represents an commission for a specific agent
+An FS::agent_pkg_class object represents a commission for a specific agent
 and package class.  FS::agent_pkg_class inherits from FS::Record.  The
 following fields are currently supported:
 
@@ -109,7 +111,7 @@ sub check {
 
 =head1 SEE ALSO
 
-L<FS::Record>, schema.html from the base documentation.
+L<FS::agent>, L<FS::pkg_class>, L<FS::Record>.
 
 =cut
 
diff --git a/FS/FS/sales_pkg_class.pm b/FS/FS/sales_pkg_class.pm
new file mode 100644 (file)
index 0000000..0fb7e86
--- /dev/null
@@ -0,0 +1,124 @@
+package FS::sales_pkg_class;
+use base qw( FS::Record );
+
+use strict;
+#use FS::Record qw( qsearch qsearchs );
+use FS::sales;
+use FS::pkg_class;
+
+=head1 NAME
+
+FS::sales_pkg_class - Object methods for sales_pkg_class records
+
+=head1 SYNOPSIS
+
+  use FS::sales_pkg_class;
+
+  $record = new FS::sales_pkg_class \%hash;
+  $record = new FS::sales_pkg_class { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::sales_pkg_class object represents a commission for a specific sales
+person and package class.  FS::sales_pkg_class inherits from FS::Record.  The
+following fields are currently supported:
+
+=over 4
+
+=item salespkgclassnum
+
+primary key
+
+=item salesnum
+
+salesnum
+
+=item classnum
+
+classnum
+
+=item commission_percent
+
+commission_percent
+
+=item commission_duration
+
+commission_duration
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new record.  To add the record to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+sub table { 'sales_pkg_class'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=item delete
+
+Delete this record from the database.
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=item check
+
+Checks all fields to make sure this is a valid record.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+sub check {
+  my $self = shift;
+
+  $self->commission_percent(0) unless length($self->commission_percent);
+
+  my $error = 
+    $self->ut_numbern('salespkgclassnum')
+    || $self->ut_foreign_key('salesnum', 'sales', 'salesnum')
+    || $self->ut_foreign_keyn('classnum', 'pkg_class', 'classnum')
+    || $self->ut_float('commission_percent')
+    || $self->ut_numbern('commission_duration')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::sales>, L<FS::pkg_class, L<FS::Record>.
+
+=cut
+
+1;
+
index a6e87f6..1bb5cbd 100644 (file)
@@ -716,3 +716,5 @@ FS/vend_pay.pm
 t/vend_pay.t
 FS/vend_bill_pay.pm
 t/vend_bill_pay.t
+FS/sales_pkg_class.pm
+t/sales_pkg_class.t
diff --git a/FS/t/sales_pkg_class.t b/FS/t/sales_pkg_class.t
new file mode 100644 (file)
index 0000000..a07cf09
--- /dev/null
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::sales_pkg_class;
+$loaded=1;
+print "ok 1\n";
index 1cdc490..6fac058 100644 (file)
 <%init>
 
 my $curuser = $FS::CurrentUser::CurrentUser;
-
 die "access denied" unless $curuser->access_right('Edit sales people');
 
+#Sales people bring in business.<BR><BR>
+
 my @header = ( 'Sales person' );
 my @fields = ( 'salesperson' );
 my @links  = ( [$p.'edit/sales.html?', 'salesnum'] );
@@ -27,6 +28,45 @@ if ( $curuser->access_right('Configuration') ) {
   push @links,  [ $p.'edit/agent.cgi?', 'agentnum' ];
 }
 
-#Sales people bring in business.<BR><BR>
+push @header, 'Commissions';
+push @fields, sub {
+
+  my $sales = shift;
+
+  #started out as false laziness w/browse/agent.cgi
+  #  (which said surprising amount of false laziness w/ edit/process/agent.cgi)
+  # but this now returns an edit.html data structure that renders to a table
+  #  instead of HTML
+
+  my @pkg_class = qsearch('pkg_class', { 'disabled'=>'' });
+
+  [
+    map {
+          my %sales_pkg_class = ( 'salesnum' => $sales->salesnum,
+                                  'classnum' => $_ ? $_->classnum : ''
+                                );
+          my $sales_pkg_class =
+            qsearchs( 'sales_pkg_class', \%sales_pkg_class )
+            || new FS::sales_pkg_class   \%sales_pkg_class;
+          #my $param = 'classnum'. $sales_pkg_class{classnum};
+
+          [
+            { align => 'right',
+              data  => ($sales_pkg_class->commission_percent || 0). '%',
+            },
+            { align => 'left',
+              data  => '&nbsp;'. encode_entities(
+                         $_ ? $_->classname : mt('(no package class)')
+                       ),
+            },
+          ];
+
+        }
+      ( '', @pkg_class )
+
+  ];
+
+};
+#push @links, '';
 
 </%init>
index 2eddd30..15da2f0 100755 (executable)
 </TABLE>
 <BR>
 
-<FONT CLASS="fsinnerbox-title"><% mt('Commissions') |h %></FONT>
-<TABLE CLASS="fsinnerbox">
-
-% #surprising amount of false laziness w/ edit/process/agent.cgi
-% my @pkg_class = qsearch('pkg_class', { 'disabled'=>'' });
-% foreach my $pkg_class ( '', @pkg_class ) {
-%   my %agent_pkg_class = ( 'agentnum' => $agent->agentnum,
-%                           'classnum' => $pkg_class ? $pkg_class->classnum : ''
-%                         );
-%   my $agent_pkg_class =
-%     qsearchs( 'agent_pkg_class', \%agent_pkg_class )
-%     || new FS::agent_pkg_class   \%agent_pkg_class;
-%   my $param = 'classnum'. $agent_pkg_class{classnum};
-
-    <TR>
-      <TD><INPUT TYPE      = "text"
-                 NAME      = "<% $param %>"
-                 VALUE     = "<% $cgi->param($param) || $agent_pkg_class->commission_percent |h %>"
-                 SIZE      = 6
-                 MAXLENGTH = 7
-          >%
-      </TD>
-      <TD><% $pkg_class ? $pkg_class->classname : mt('(no package class)') |h %>
-      </TD>
-    </TR>
-
-% }
-
-</TABLE>
+<& /elements/table-commissions.html,
+     'source_obj'   => $agent,
+     'link_table'   => 'agent_pkg_class',
+     #'target_table' => 'pkg_class',
+&>
 <BR>
 
 % if ( $conf->config('currencies') ) {
index b60276d..1bb1797 100644 (file)
@@ -1,12 +1,41 @@
 <& elements/process.html,
-     'table'       => 'sales',
-     'viewall_dir' => 'browse',
-     'agent_virt'  => 1,
+     'table'            => 'sales',
+     'viewall_dir'      => 'browse',
+     'agent_virt'       => 1,
+     'noerror_callback' => $process_sales_pkg_class,
 &>
 <%init>
 
 die "access denied"
   unless $FS::CurrentUser::CurrentUser->access_right('Edit sales people');
 
+#false laziness w/process/agent.cgi
+my $process_sales_pkg_class = sub {
+  my( $cgi, $sales ) = @_;
+
+  #surprising amount of false laziness w/ edit/agent.cgi
+  my @pkg_class = qsearch('pkg_class', { 'disabled'=>'' });
+  foreach my $pkg_class ( '', @pkg_class ) {
+    my %sales_pkg_class = ( 'salesnum' => $sales->salesnum,
+                            'classnum' => $pkg_class ? $pkg_class->classnum : ''
+                          );
+    my $sales_pkg_class =
+      qsearchs( 'sales_pkg_class', \%sales_pkg_class )
+      || new FS::sales_pkg_class   \%sales_pkg_class;
+
+    my $param = 'classnum'. $sales_pkg_class{classnum};
+
+    $sales_pkg_class->commission_percent( $cgi->param($param) );
+
+    my $method = $sales_pkg_class->salespkgclassnum ? 'replace' : 'insert';
+
+    my $error = $sales_pkg_class->$method;
+    die $error if $error; #XXX push this down into sales.pm w/better/transactional error handling
+
+  }
+
+};
+
+
 </%init>
 
index 65cddfc..763f861 100755 (executable)
                         },
      'viewall_dir'   => 'browse',
      'agent_virt'    => 1,
+     'html_bottom'   => sub {
+                              my $sales = shift;
+
+                              '<BR>'.
+                              include('/elements/table-commissions.html',
+                                        'source_obj'   => $sales,
+                                        'link_table'   => 'sales_pkg_class',
+                                        #'target_table' => 'pkg_class',
+                                     );
+                            },
 &>
 <%init>
 
diff --git a/httemplate/elements/table-commissions.html b/httemplate/elements/table-commissions.html
new file mode 100644 (file)
index 0000000..ce5808d
--- /dev/null
@@ -0,0 +1,44 @@
+<FONT CLASS="fsinnerbox-title"><% mt('Commissions') |h %></FONT>
+<TABLE CLASS="fsinnerbox">
+
+% my $pkey = $object->primary_key;
+% my $pkey_value = $object->$pkey();
+% my $link_class = 'FS::'.$link_table;
+% 
+% #surprising amount of false laziness w/ edit/process/agent.cgi
+% # (somewhat less now that we're more generic)
+% my @pkg_class = qsearch($target_table, { 'disabled'=>'' });
+% foreach my $pkg_class ( '', @pkg_class ) {
+%   my %thing_pkg_class = ( $pkey    => $pkey_value,
+%                           classnum => $pkg_class ? $pkg_class->classnum : ''
+%                         );
+%   my $thing_pkg_class =
+%     qsearchs( $link_table, \%thing_pkg_class )
+%     || $link_class->new( \%thing_pkg_class );
+%   my $param = 'classnum'. $thing_pkg_class{classnum};
+
+    <TR>
+      <TD><INPUT TYPE      = "text"
+                 NAME      = "<% $param %>"
+                 VALUE     = "<% $cgi->param($param) || $thing_pkg_class->commission_percent |h %>"
+                 SIZE      = 6
+                 MAXLENGTH = 7
+          >%
+      </TD>
+      <TD><% $pkg_class ? $pkg_class->classname : mt('(no package class)') |h %>
+      </TD>
+    </TR>
+
+% }
+
+</TABLE>
+
+<%init>
+
+my %opt = @_;
+
+my $object = $opt{'source_obj'};
+my $link_table = $opt{'link_table'};
+my $target_table = $opt{'target_table'} || 'pkg_class';
+
+</%init>
index b94ae9f..2818d2e 100644 (file)
@@ -33,11 +33,10 @@ td.money:before { content: '<% $money_char %>'; }
 %   if ( $custnum ne $cust_pkg->custnum ) {
 %     # start of a new customer section
 %     my $cust_main = $cust_pkg->cust_main;
-%     my $label = $cust_main->custnum . ': '. $cust_main->name;
 %     $bgcolor = 0;
   <TR>
     <TD COLSPAN=4 CLASS="cust_head">
-      <A HREF="<%$p%>view/cust_main.cgi?<%$cust_main->custnum%>"><% $label %></A>
+      <A HREF="<%$p%>view/cust_main.cgi?<%$cust_main->custnum%>"><% $cust_main->display_custnum %>: <% $cust_main->name |h %></A>
     </TD>
   </TR>
 %   }