From 30c3ff2acf90e1386fae00759078899c859faf36 Mon Sep 17 00:00:00 2001 From: jeff Date: Tue, 3 Oct 2006 22:44:28 +0000 Subject: [PATCH] Enhanced customer notes --- FS/FS/AccessRight.pm | 1 + FS/FS/Conf.pm | 21 +++++ FS/FS/Schema.pm | 13 +++ FS/FS/cust_main.pm | 16 ++++ FS/FS/cust_main_note.pm | 131 +++++++++++++++++++++++++++++ FS/MANIFEST | 2 + FS/t/cust_main_note.t | 5 ++ httemplate/edit/cust_main.cgi | 7 +- httemplate/edit/cust_main_note.cgi | 37 ++++++++ httemplate/edit/process/cust_main_note.cgi | 34 ++++++++ httemplate/view/cust_main.cgi | 28 ++++++ httemplate/view/cust_main/notes.html | 74 ++++++++++++++++ 12 files changed, 367 insertions(+), 2 deletions(-) create mode 100644 FS/FS/cust_main_note.pm create mode 100644 FS/t/cust_main_note.t create mode 100755 httemplate/edit/cust_main_note.cgi create mode 100755 httemplate/edit/process/cust_main_note.cgi create mode 100755 httemplate/view/cust_main/notes.html diff --git a/FS/FS/AccessRight.pm b/FS/FS/AccessRight.pm index 83291b8d4..aa4586688 100644 --- a/FS/FS/AccessRight.pm +++ b/FS/FS/AccessRight.pm @@ -92,6 +92,7 @@ assigned to users and/or groups. 'Cancel customer', 'Complimentary customer', #aka users-allow_comp 'Delete customer', #aka. deletecustomers #Enable customer deletions. Be very careful! Deleting a customer will remove all traces that this customer ever existed! It should probably only be used when auditing a legacy database. Normally, you cancel all of a customers' packages if they cancel service. + 'Add customer note', ### # customer package rights diff --git a/FS/FS/Conf.pm b/FS/FS/Conf.pm index ee1692a62..384ff5215 100644 --- a/FS/FS/Conf.pm +++ b/FS/FS/Conf.pm @@ -1744,6 +1744,27 @@ httemplate/docs/config.html }, { + 'key' => 'cust_main-use_comments', + 'section' => 'UI', + 'description' => 'Display free form comments on the customer edit screen. Useful as a scratch pad.', + 'type' => 'checkbox', + }, + + { + 'key' => 'cust_main-use_notes', + 'section' => 'UI', + 'description' => 'Display link to add timestamped and user identified customr notes. Useful in tracking who did what.', + 'type' => 'checkbox', + }, + + { + 'key' => 'cust_main_note-display_times', + 'section' => 'UI', + 'description' => 'Display full timestamps (not just dates) for customer notes.', + 'type' => 'checkbox', + }, + + { 'key' => 'cust_main-ticket_statuses', 'section' => 'UI', 'description' => 'Show tickets with these statuses on the customer view page.', diff --git a/FS/FS/Schema.pm b/FS/FS/Schema.pm index ef697b98c..3d4fcc5b4 100644 --- a/FS/FS/Schema.pm +++ b/FS/FS/Schema.pm @@ -473,6 +473,19 @@ sub tables_hashref { 'index' => [ ['custnum'], ], }, + 'cust_main_note' => { + 'columns' => [ + 'notenum', 'serial', '', '', '', '', + 'custnum', 'int', '', '', '', '', + '_date', @date_type, '', '', + 'otaker', 'varchar', '', 32, '', '', + 'comments', 'text', 'NULL', '', '', '', + ], + 'primary_key' => 'notenum', + 'unique' => [], + 'index' => [ [ 'custnum' ], [ '_date' ], ], + }, + 'cust_main_county' => { #county+state+country are checked off the #cust_main_county for validation and to provide # a tax rate. diff --git a/FS/FS/cust_main.pm b/FS/FS/cust_main.pm index 875db930b..484138781 100644 --- a/FS/FS/cust_main.pm +++ b/FS/FS/cust_main.pm @@ -1732,6 +1732,22 @@ sub _banned_pay_hashref { }; } +=item notes + +Returns all notes (see L) for this customer. + +=cut + +sub notes { + my $self = shift; + #order by? + qsearch( 'cust_main_note', + { 'custnum' => $self->custnum }, + '', + 'ORDER BY _DATE DESC' + ); +} + =item agent Returns the agent (see L) for this customer. diff --git a/FS/FS/cust_main_note.pm b/FS/FS/cust_main_note.pm new file mode 100644 index 000000000..4732d12ce --- /dev/null +++ b/FS/FS/cust_main_note.pm @@ -0,0 +1,131 @@ +package FS::cust_main_note; + +use strict; +use vars qw( @ISA ); +use FS::Record qw( qsearch qsearchs ); + +@ISA = qw(FS::Record); + +=head1 NAME + +FS::cust_main_note - Object methods for cust_main_note records + +=head1 SYNOPSIS + + use FS::cust_main_note; + + $record = new FS::cust_main_note \%hash; + $record = new FS::cust_main_note { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::cust_main_note object represents a note attachted to a customer. +FS::cust_main_note inherits from FS::Record. The following fields are +currently supported: + +=over 4 + +=item notenum - primary key + +=item custnum - + +=item _date - + +=item otaker - + +=item comments - + + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new customer note. To add the note 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 method. + +=cut + +# the new method can be inherited from FS::Record, if a table method is defined + +sub table { 'cust_main_note'; } + +=item insert + +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +=cut + +# the insert method can be inherited from FS::Record + +=item delete + +Delete this record from the database. + +=cut + +# the delete method can be inherited from FS::Record + +=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. + +=cut + +# the replace method can be inherited from FS::Record + +=item check + +Checks all fields to make sure this is a valid example. If there is +an error, returns the error, otherwise returns false. Called by the insert +and replace methods. + +=cut + +# the check method should currently be supplied - FS::Record contains some +# data checking routines + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('notenum') + || $self->ut_number('custnum') + || $self->ut_numbern('_date') + || $self->ut_text('otaker') + || $self->ut_anything('comments') + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +Lurking in the cracks. + +=head1 SEE ALSO + +L, schema.html from the base documentation. + +=cut + +1; + diff --git a/FS/MANIFEST b/FS/MANIFEST index db091773b..c67145b42 100644 --- a/FS/MANIFEST +++ b/FS/MANIFEST @@ -356,3 +356,5 @@ FS/cust_bill_pay_pkg.pm t/cust_bill_pay_pkg.t FS/cust_credit_bill_pkg.pm t/cust_credit_bill_pkg.t +FS/cust_main_note.pm +t/cust_main_note.t diff --git a/FS/t/cust_main_note.t b/FS/t/cust_main_note.t new file mode 100644 index 000000000..41a7bac0b --- /dev/null +++ b/FS/t/cust_main_note.t @@ -0,0 +1,5 @@ +BEGIN { $| = 1; print "1..1\n" } +END {print "not ok 1\n" unless $loaded;} +use FS::cust_main_note; +$loaded=1; +print "ok 1\n"; diff --git a/httemplate/edit/cust_main.cgi b/httemplate/edit/cust_main.cgi index dfcd0401f..99f849fc8 100755 --- a/httemplate/edit/cust_main.cgi +++ b/httemplate/edit/cust_main.cgi @@ -359,17 +359,20 @@ function copyelement(from, to) { % } - +% +% my $ro_comments = $conf->exists('cust_main-use_comments')?'':'readonly'; +% if (!$ro_comments || $cust_main->comments) {
Comments <% &ntable("#cccccc") %> - + % +% } % %unless ( $custnum ) { % # pry the wrong place for this logic. also pretty expensive diff --git a/httemplate/edit/cust_main_note.cgi b/httemplate/edit/cust_main_note.cgi new file mode 100755 index 000000000..468ef0051 --- /dev/null +++ b/httemplate/edit/cust_main_note.cgi @@ -0,0 +1,37 @@ +<% include('/elements/header-popup.html', 'Add Customer Note') %> + +% if ( $cgi->param('error') ) { + Error: <% $cgi->param('error') %> +

+% } + +
+ + + +

+ + +

+ + +
+ + + +<%init> +my($custnum, $comment); +$comment = ''; + +if ( $cgi->param('error') ) { + $comment = $cgi->param('comment'); +} +$cgi->param('custnum') =~ /^(\d+)$/; +$custnum = $1; + +die "illegal query ". $cgi->keywords unless $custnum; + + + diff --git a/httemplate/edit/process/cust_main_note.cgi b/httemplate/edit/process/cust_main_note.cgi new file mode 100755 index 000000000..d9251f042 --- /dev/null +++ b/httemplate/edit/process/cust_main_note.cgi @@ -0,0 +1,34 @@ +% +% +%$cgi->param('custnum') =~ /^(\d+)$/ +% or die "Illegal custnum: ". $cgi->param('custnum'); +%my $custnum = $1; +% +%my $otaker = $FS::CurrentUser::CurrentUser->name; +%$otaker = $FS::CurrentUser::CurrentUser->username +% if ($otaker eq "User, Legacy"); +% +%my $new = new FS::cust_main_note ( { +% custnum => $custnum, +% _date => time, +% otaker => $otaker, +% comments => $cgi->param('comment'), +%} ); +% +%my $error = $new->insert; +% +%if ($error) { +% $cgi->param('error', $error); +% print $cgi->redirect(popurl(2). 'cust_main_note.cgi?'. $cgi->query_string ); +%} +% +% +<% header('Note added') %> + + + +% +% + diff --git a/httemplate/view/cust_main.cgi b/httemplate/view/cust_main.cgi index e82a5196c..6b2277756 100755 --- a/httemplate/view/cust_main.cgi +++ b/httemplate/view/cust_main.cgi @@ -116,6 +116,34 @@ Comments % } +

+% my $notecount = scalar($cust_main->notes()); +% if ($conf->exists('cust_main-use_notes') || $notecount) { + +Notes
+% if ( $curuser->access_right('Add customer note') && +% $conf->exists('cust_main-use_notes') +% ) { + + Add customer note + +% } + +
+ +% if ($notecount) { + + + +% } else { + +
+% } +% } + + % if ( $conf->config('ticket_system') ) {
diff --git a/httemplate/view/cust_main/notes.html b/httemplate/view/cust_main/notes.html new file mode 100755 index 000000000..c1a33b020 --- /dev/null +++ b/httemplate/view/cust_main/notes.html @@ -0,0 +1,74 @@ +% +% my $conf = new FS::Conf; +% +% $cgi->param('custnum') =~ /^(\d+)$/ +% or die "No customer specified (bad URL)!"; +% my $custnum = $1; +% +% my $cust_main = qsearchs('cust_main', {'custnum' => $custnum} ); +% die "Custimer not found!" unless $cust_main; +% +% my (@notes) = $cust_main->notes(); +% if ( scalar(@notes) ) { + + + + + +%#<% include('/elements/table-grid.html') %> +% my $bgcolor1 = '#eeeeee'; +% my $bgcolor2 = '#ffffff'; +% my $bgcolor = ''; +% +% foreach my $note (@notes) { +% +% if ( $bgcolor eq $bgcolor1 ) { +% $bgcolor = $bgcolor2; +% } else { +% $bgcolor = $bgcolor1; +% } +% +% + + + <% note_datestr($note,$conf,$bgcolor) %> + + + + +% } #end display notes + +
+  <%$note->otaker%>  + +  <%$note->comments%> +
+% } else { + +
+% } +% +%#subroutines +% +%sub note_datestr { +% my($note, $conf, $bgcolor) = @_ or return ''; +% my $format=qq{%b}. +% qq{ %o,}. +% qq{ %Y }; +% $format .= qq{ %l}. +% qq{:}. +% qq{%M}. +% qq{ %P } +% if $conf->exists('cust_main_note-display_times'); +% ( my $strip = time2str($format, $note->_date) ) =~ s/ (\d)/$1/g; +% $strip; +% } +% + -- 2.11.0