1 package SL::Controller::CsvImport::Order;
6 use List::MoreUtils qw(any);
10 use SL::DB::OrderItem;
12 use SL::DB::PaymentTerm;
14 use SL::DB::Department;
15 use SL::DB::PriceFactor;
16 use SL::DB::Pricegroup;
22 use parent qw(SL::Controller::CsvImport::BaseMulti);
25 use Rose::Object::MakeMethods::Generic
27 'scalar --get_set_init' => [ qw(settings languages_by parts_by contacts_by departments_by projects_by ct_shiptos_by taxzones_by price_factors_by pricegroups_by) ],
33 $self->class(['SL::DB::Order', 'SL::DB::OrderItem']);
40 return { map { ( $_ => $self->controller->profile->get($_) ) } qw(order_column item_column) };
47 my $profile = $self->SUPER::init_profile;
49 foreach my $p (@{ $profile }) {
50 my $prof = $p->{profile};
51 if ($p->{row_ident} eq 'Order') {
53 delete @{$prof}{qw(delivery_customer_id delivery_vendor_id proforma quotation amount netamount)};
54 # handable, but not handled by now
56 if ($p->{row_ident} eq 'OrderItem') {
57 delete @{$prof}{qw(trans_id)};
65 sub setup_displayable_columns {
68 $self->SUPER::setup_displayable_columns;
70 $self->add_displayable_columns('Order',
71 { name => 'datatype', description => $::locale->text('Zeilenkennung') },
72 { name => 'closed', description => $::locale->text('Closed') },
73 { name => 'curr', description => $::locale->text('Currency') },
74 { name => 'cusordnumber', description => $::locale->text('Customer Order Number') },
75 { name => 'delivered', description => $::locale->text('Delivered') },
76 { name => 'employee_id', description => $::locale->text('Employee (database ID)') },
77 { name => 'intnotes', description => $::locale->text('Internal Notes') },
78 { name => 'marge_percent', description => $::locale->text('Margepercent') },
79 { name => 'marge_total', description => $::locale->text('Margetotal') },
80 { name => 'notes', description => $::locale->text('Notes') },
81 { name => 'ordnumber', description => $::locale->text('Order Number') },
82 { name => 'quonumber', description => $::locale->text('Quotation Number') },
83 { name => 'reqdate', description => $::locale->text('Reqdate') },
84 { name => 'salesman_id', description => $::locale->text('Salesman (database ID)') },
85 { name => 'shippingpoint', description => $::locale->text('Shipping Point') },
86 { name => 'shipvia', description => $::locale->text('Ship via') },
87 { name => 'transaction_description', description => $::locale->text('Transaction description') },
88 { name => 'transdate', description => $::locale->text('Order Date') },
89 { name => 'verify_amount', description => $::locale->text('Amount (for verification)') },
90 { name => 'verify_netamount', description => $::locale->text('Net amount (for verification)') },
91 { name => 'taxincluded', description => $::locale->text('Tax Included') },
92 { name => 'customer', description => $::locale->text('Customer (name)') },
93 { name => 'customernumber', description => $::locale->text('Customer Number') },
94 { name => 'customer_id', description => $::locale->text('Customer (database ID)') },
95 { name => 'vendor', description => $::locale->text('Vendor (name)') },
96 { name => 'vendornumber', description => $::locale->text('Vendor Number') },
97 { name => 'vendor_id', description => $::locale->text('Vendor (database ID)') },
98 { name => 'language_id', description => $::locale->text('Language (database ID)') },
99 { name => 'language', description => $::locale->text('Language (name)') },
100 { name => 'payment_id', description => $::locale->text('Payment terms (database ID)') },
101 { name => 'payment', description => $::locale->text('Payment terms (name)') },
102 { name => 'taxzone_id', description => $::locale->text('Steuersatz (database ID') },
103 { name => 'taxzone', description => $::locale->text('Steuersatz (description)') },
104 { name => 'cp_id', description => $::locale->text('Contact Person (database ID)') },
105 { name => 'contact', description => $::locale->text('Contact Person (name)') },
106 { name => 'department_id', description => $::locale->text('Department (database ID)') },
107 { name => 'department', description => $::locale->text('Department (description)') },
108 { name => 'globalproject_id', description => $::locale->text('Document Project (database ID)') },
109 { name => 'globalprojectnumber', description => $::locale->text('Document Project (number)') },
110 { name => 'globalproject', description => $::locale->text('Document Project (description)') },
111 { name => 'shipto_id', description => $::locale->text('Ship to (database ID)') },
114 $self->add_displayable_columns('OrderItem',
115 { name => 'datatype', description => $::locale->text('Zeilenkennung') },
116 { name => 'cusordnumber', description => $::locale->text('Customer Order Number') },
117 { name => 'description', description => $::locale->text('Description') },
118 { name => 'discount', description => $::locale->text('Discount') },
119 { name => 'lastcost', description => $::locale->text('Lastcost') },
120 { name => 'longdescription', description => $::locale->text('Long Description') },
121 { name => 'marge_percent', description => $::locale->text('Margepercent') },
122 { name => 'marge_total', description => $::locale->text('Margetotal') },
123 { name => 'ordnumber', description => $::locale->text('Order Number') },
124 { name => 'parts_id', description => $::locale->text('Part (database ID)') },
125 { name => 'partnumber', description => $::locale->text('Part Number') },
126 { name => 'project_id', description => $::locale->text('Project (database ID)') },
127 { name => 'projectnumber', description => $::locale->text('Project (number)') },
128 { name => 'project', description => $::locale->text('Project (description)') },
129 { name => 'price_factor_id', description => $::locale->text('Price factor (database ID)') },
130 { name => 'price_factor', description => $::locale->text('Price factor (name)') },
131 { name => 'pricegroup_id', description => $::locale->text('Price group (database ID)') },
132 { name => 'pricegroup', description => $::locale->text('Price group (name)') },
133 { name => 'qty', description => $::locale->text('Quantity') },
134 { name => 'reqdate', description => $::locale->text('Reqdate') },
135 { name => 'sellprice', description => $::locale->text('Sellprice') },
136 { name => 'serialnumber', description => $::locale->text('Serial No.') },
137 { name => 'subtotal', description => $::locale->text('Subtotal') },
138 { name => 'unit', description => $::locale->text('Unit') },
143 sub init_languages_by {
146 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $self->all_languages } } ) } qw(id description article_code) };
152 my $all_parts = SL::DB::Manager::Part->get_all;
153 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_parts } } ) } qw(id partnumber ean description) };
156 sub init_contacts_by {
159 my $all_contacts = SL::DB::Manager::Contact->get_all;
162 # by customer/vendor id _and_ contact person id
163 $cby->{'cp_cv_id+cp_id'} = { map { ( $_->cp_cv_id . '+' . $_->cp_id => $_ ) } @{ $all_contacts } };
164 # by customer/vendor id _and_ contact person name
165 $cby->{'cp_cv_id+cp_name'} = { map { ( $_->cp_cv_id . '+' . $_->cp_name => $_ ) } @{ $all_contacts } };
170 sub init_departments_by {
173 my $all_departments = SL::DB::Manager::Department->get_all;
174 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_departments } } ) } qw(id description) };
177 sub init_projects_by {
180 my $all_projects = SL::DB::Manager::Project->get_all;
181 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_projects } } ) } qw(id projectnumber description) };
184 sub init_ct_shiptos_by {
187 my $all_ct_shiptos = SL::DB::Manager::Shipto->get_all(query => [module => 'CT']);
190 # by trans_id _and_ shipto_id
191 $sby->{'trans_id+shipto_id'} = { map { ( $_->trans_id . '+' . $_->shipto_id => $_ ) } @{ $all_ct_shiptos } };
196 sub init_taxzones_by {
199 my $all_taxzones = SL::DB::Manager::TaxZone->get_all;
200 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_taxzones } } ) } qw(id description) };
203 sub init_price_factors_by {
206 my $all_price_factors = SL::DB::Manager::PriceFactor->get_all;
207 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_price_factors } } ) } qw(id description) };
210 sub init_pricegroups_by {
213 my $all_pricegroups = SL::DB::Manager::Pricegroup->get_all;
214 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_pricegroups } } ) } qw(id pricegroup) };
220 $self->controller->track_progress(phase => 'building data', progress => 0);
223 my $num_data = scalar @{ $self->controller->data };
224 foreach my $entry (@{ $self->controller->data }) {
225 $self->controller->track_progress(progress => $i/$num_data * 100) if $i % 100 == 0;
227 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
230 if (any { $entry->{raw_data}->{$_} } qw(customer customernumber customer_id)) {
231 $self->check_vc($entry, 'customer_id');
232 $vc_obj = SL::DB::Customer->new(id => $entry->{object}->customer_id)->load if $entry->{object}->customer_id;
233 } elsif (any { $entry->{raw_data}->{$_} } qw(vendor vendornumber vendor_id)) {
234 $self->check_vc($entry, 'vendor_id');
235 $vc_obj = SL::DB::Vendor->new(id => $entry->{object}->vendor_id)->load if $entry->{object}->vendor_id;
237 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor missing');
240 $self->check_contact($entry);
241 $self->check_language($entry);
242 $self->check_payment($entry);
243 $self->check_department($entry);
244 $self->check_project($entry, global => 1);
245 $self->check_ct_shipto($entry);
246 $self->check_taxzone($entry);
249 # copy from customer if not given
250 foreach (qw(payment_id language_id taxzone_id)) {
251 $entry->{object}->$_($vc_obj->$_) unless $entry->{object}->$_;
255 # ToDo: salesman and emloyee by name
256 # salesman from customer or login if not given
257 if (!$entry->{object}->salesman) {
258 if ($vc_obj && $vc_obj->salesman_id) {
259 $entry->{object}->salesman(SL::DB::Manager::Employee->find_by(id => $vc_obj->salesman_id));
261 $entry->{object}->salesman(SL::DB::Manager::Employee->find_by(login => $::myconfig{login}));
265 # employee from login if not given
266 if (!$entry->{object}->employee_id) {
267 $entry->{object}->employee_id(SL::DB::Manager::Employee->find_by(login => $::myconfig{login})->id);
273 $self->add_info_columns($self->settings->{'order_column'},
274 { header => $::locale->text('Customer/Vendor'), method => 'vc_name' });
275 # Todo: access via ->[0] ok? Better: search first order column and use this
276 $self->add_columns($self->settings->{'order_column'},
277 map { "${_}_id" } grep { exists $self->controller->data->[0]->{raw_data}->{$_} } qw(payment language department globalproject taxzone cp));
278 $self->add_columns($self->settings->{'order_column'}, 'globalproject_id') if exists $self->controller->data->[0]->{raw_data}->{globalprojectnumber};
279 $self->add_columns($self->settings->{'order_column'}, 'cp_id') if exists $self->controller->data->[0]->{raw_data}->{contact};
281 foreach my $entry (@{ $self->controller->data }) {
282 if ($entry->{raw_data}->{datatype} eq $self->settings->{'item_column'} && $entry->{object}->can('part')) {
284 next if !$self->check_part($entry);
286 my $part_obj = SL::DB::Part->new(id => $entry->{object}->parts_id)->load;
288 # copy from part if not given
289 $entry->{object}->description($part_obj->description) unless $entry->{object}->description;
290 $entry->{object}->longdescription($part_obj->notes) unless $entry->{object}->longdescription;
291 $entry->{object}->unit($part_obj->unit) unless $entry->{object}->unit;
293 # set to 0 if not given
294 $entry->{object}->discount(0) unless $entry->{object}->discount;
295 $entry->{object}->ship(0) unless $entry->{object}->ship;
297 $self->check_project($entry, global => 0);
298 $self->check_price_factor($entry);
299 $self->check_pricegroup($entry);
304 $self->add_info_columns($self->settings->{'item_column'},
305 { header => $::locale->text('Part Number'), method => 'partnumber' });
306 # Todo: access via ->[1] ok? Better: search first item column and use this
307 $self->add_columns($self->settings->{'item_column'},
308 map { "${_}_id" } grep { exists $self->controller->data->[1]->{raw_data}->{$_} } qw(project price_factor pricegroup));
309 $self->add_columns($self->settings->{'item_column'}, 'project_id') if exists $self->controller->data->[1]->{raw_data}->{projectnumber};
311 # add orderitems to order
314 foreach my $entry (@{ $self->controller->data }) {
316 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
318 # new order entry: add collected orderitems to the last one
319 if (defined $order_entry) {
320 $order_entry->{object}->orderitems(@orderitems);
324 $order_entry = $entry;
326 } elsif ( defined $order_entry && $entry->{raw_data}->{datatype} eq $self->settings->{'item_column'} ) {
327 # collect orderitems to add to order (if they have no errors)
328 # ( add_orderitems does not work here if we want to call
329 # calculate_prices_and_taxes afterwards ...
330 # so collect orderitems and add them at once)
331 if (scalar @{ $entry->{errors} } == 0) {
332 push @orderitems, $entry->{object};
336 # add last collected orderitems to last order
338 $order_entry->{object}->orderitems(@orderitems);
341 # calculate prices and taxes
342 foreach my $entry (@{ $self->controller->data }) {
343 next if @{ $entry->{errors} };
345 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
347 $entry->{object}->calculate_prices_and_taxes;
349 $entry->{info_data}->{calc_amount} = $entry->{object}->amount_as_number;
350 $entry->{info_data}->{calc_netamount} = $entry->{object}->netamount_as_number;
354 # If amounts are given, show calculated amounts as info and given amounts (verify_xxx).
355 # And throw an error if the differences are too big.
357 my @to_verify = ( { column => 'amount',
358 raw_column => 'verify_amount',
359 info_header => 'Calc. Amount',
360 info_method => 'calc_amount',
361 err_msg => 'Amounts differ too much',
363 { column => 'netamount',
364 raw_column => 'verify_netamount',
365 info_header => 'Calc. Net amount',
366 info_method => 'calc_netamount',
367 err_msg => 'Net amounts differ too much',
370 foreach my $tv (@to_verify) {
371 # Todo: access via ->[0] ok? Better: search first order column and use this
372 if (exists $self->controller->data->[0]->{raw_data}->{ $tv->{raw_column} }) {
373 $self->add_raw_data_columns($self->settings->{'order_column'}, $tv->{raw_column});
374 $self->add_info_columns($self->settings->{'order_column'},
375 { header => $::locale->text($tv->{info_header}), method => $tv->{info_method} });
379 foreach my $entry (@{ $self->controller->data }) {
380 next if @{ $entry->{errors} };
381 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
382 next if !$entry->{raw_data}->{ $tv->{raw_column} };
383 my $parsed_value = $::form->parse_amount(\%::myconfig, $entry->{raw_data}->{ $tv->{raw_column} });
384 if (abs($entry->{object}->${ \$tv->{column} } - $parsed_value) > $max_diff) {
385 push @{ $entry->{errors} }, $::locale->text($tv->{err_msg});
391 # If order has errors set error for orderitems as well
393 foreach my $entry (@{ $self->controller->data }) {
395 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'}) {
396 $order_entry = $entry;
397 } elsif ( defined $order_entry
398 && $entry->{raw_data}->{datatype} eq $self->settings->{'item_column'}
399 && scalar @{ $order_entry->{errors} } > 0 ) {
400 push @{ $entry->{errors} }, $::locale->text('order not valid for this orderitem!');
408 my ($self, $entry) = @_;
410 my $object = $entry->{object};
412 # Check whether or not language ID is valid.
413 if ($object->language_id && !$self->languages_by->{id}->{ $object->language_id }) {
414 push @{ $entry->{errors} }, $::locale->text('Error: Invalid language');
418 # Map name to ID if given.
419 if (!$object->language_id && $entry->{raw_data}->{language}) {
420 my $language = $self->languages_by->{description}->{ $entry->{raw_data}->{language} }
421 || $self->languages_by->{article_code}->{ $entry->{raw_data}->{language} };
424 push @{ $entry->{errors} }, $::locale->text('Error: Invalid language');
428 $object->language_id($language->id);
431 if ($object->language_id) {
432 $entry->{info_data}->{language} = $self->languages_by->{id}->{ $object->language_id }->description;
439 my ($self, $entry) = @_;
441 my $object = $entry->{object};
443 # Check wether or non part ID is valid.
444 if ($object->parts_id && !$self->parts_by->{id}->{ $object->parts_id }) {
445 push @{ $entry->{errors} }, $::locale->text('Error: Invalid part');
449 # Map number to ID if given.
450 if (!$object->parts_id && $entry->{raw_data}->{partnumber}) {
451 my $part = $self->parts_by->{partnumber}->{ $entry->{raw_data}->{partnumber} };
453 push @{ $entry->{errors} }, $::locale->text('Error: Invalid part');
457 $object->parts_id($part->id);
460 if ($object->parts_id) {
461 $entry->{info_data}->{partnumber} = $self->parts_by->{id}->{ $object->parts_id }->partnumber;
463 push @{ $entry->{errors} }, $::locale->text('Error: Part not found');
471 my ($self, $entry) = @_;
473 my $object = $entry->{object};
475 my $cp_cv_id = $object->customer_id || $object->vendor_id;
476 return 0 unless $cp_cv_id;
478 # Check wether or not contact ID is valid.
479 if ($object->cp_id && !$self->contacts_by->{'cp_cv_id+cp_id'}->{ $cp_cv_id . '+' . $object->cp_id }) {
480 push @{ $entry->{errors} }, $::locale->text('Error: Invalid contact');
484 # Map name to ID if given.
485 if (!$object->cp_id && $entry->{raw_data}->{contact}) {
486 my $cp = $self->contacts_by->{'cp_cv_id+cp_name'}->{ $cp_cv_id . '+' . $entry->{raw_data}->{contact} };
488 push @{ $entry->{errors} }, $::locale->text('Error: Invalid contact');
492 $object->cp_id($cp->cp_id);
495 if ($object->cp_id) {
496 $entry->{info_data}->{contact} = $self->contacts_by->{'cp_cv_id+cp_id'}->{ $cp_cv_id . '+' . $object->cp_id }->cp_name;
502 sub check_department {
503 my ($self, $entry) = @_;
505 my $object = $entry->{object};
507 # Check wether or not department ID is valid.
508 if ($object->department_id && !$self->departments_by->{id}->{ $object->department_id }) {
509 push @{ $entry->{errors} }, $::locale->text('Error: Invalid department');
513 # Map description to ID if given.
514 if (!$object->department_id && $entry->{raw_data}->{department}) {
515 my $dep = $self->departments_by->{description}->{ $entry->{raw_data}->{department} };
517 push @{ $entry->{errors} }, $::locale->text('Error: Invalid department');
521 $object->department_id($dep->id);
528 my ($self, $entry, %params) = @_;
530 my $id_column = ($params{global} ? 'global' : '') . 'project_id';
531 my $number_column = ($params{global} ? 'global' : '') . 'projectnumber';
532 my $description_column = ($params{global} ? 'global' : '') . 'project';
534 my $object = $entry->{object};
536 # Check wether or not projetc ID is valid.
537 if ($object->$id_column && !$self->projects_by->{id}->{ $object->$id_column }) {
538 push @{ $entry->{errors} }, $::locale->text('Error: Invalid project');
542 # Map number to ID if given.
543 if (!$object->$id_column && $entry->{raw_data}->{$number_column}) {
544 my $proj = $self->projects_by->{projectnumber}->{ $entry->{raw_data}->{$number_column} };
546 push @{ $entry->{errors} }, $::locale->text('Error: Invalid project');
550 $object->$id_column($proj->id);
553 # Map description to ID if given.
554 if (!$object->$id_column && $entry->{raw_data}->{$description_column}) {
555 my $proj = $self->projects_by->{description}->{ $entry->{raw_data}->{$description_column} };
557 push @{ $entry->{errors} }, $::locale->text('Error: Invalid project');
561 $object->$id_column($proj->id);
567 sub check_ct_shipto {
568 my ($self, $entry) = @_;
570 my $object = $entry->{object};
572 my $trans_id = $object->customer_id || $object->vendor_id;
573 return 0 unless $trans_id;
575 # Check wether or not shipto ID is valid.
576 if ($object->shipto_id && !$self->ct_shiptos_by->{'trans_id+shipto_id'}->{ $trans_id . '+' . $object->shipto_id }) {
577 push @{ $entry->{errors} }, $::locale->text('Error: Invalid shipto');
585 my ($self, $entry) = @_;
587 my $object = $entry->{object};
589 # Check wether or not taxzone ID is valid.
590 if ($object->taxzone_id && !$self->taxzones_by->{id}->{ $object->taxzone_id }) {
591 push @{ $entry->{errors} }, $::locale->text('Error: Invalid taxzone');
595 # Map description to ID if given.
596 if (!$object->taxzone_id && $entry->{raw_data}->{taxzone}) {
597 my $taxzone = $self->taxzones_by->{description}->{ $entry->{raw_data}->{taxzone} };
599 push @{ $entry->{errors} }, $::locale->text('Error: Invalid taxzone');
603 $object->taxzone_id($taxzone->id);
610 sub check_price_factor {
611 my ($self, $entry) = @_;
613 my $object = $entry->{object};
615 # Check wether or not price_factor ID is valid.
616 if ($object->price_factor_id && !$self->price_factors_by->{id}->{ $object->price_factor_id }) {
617 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price factor');
621 # Map description to ID if given.
622 if (!$object->price_factor_id && $entry->{raw_data}->{price_factor}) {
623 my $price_factor = $self->price_factors_by->{description}->{ $entry->{raw_data}->{price_factor} };
624 if (!$price_factor) {
625 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price factor');
629 $object->price_factor_id($price_factor->id);
635 sub check_pricegroup {
636 my ($self, $entry) = @_;
638 my $object = $entry->{object};
640 # Check wether or not pricegroup ID is valid.
641 if ($object->pricegroup_id && !$self->pricegroups_by->{id}->{ $object->pricegroup_id }) {
642 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price group');
646 # Map pricegroup to ID if given.
647 if (!$object->pricegroup_id && $entry->{raw_data}->{pricegroup}) {
648 my $pricegroup = $self->pricegroups_by->{pricegroup}->{ $entry->{raw_data}->{pricegroup} };
650 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price group');
654 $object->pricegroup_id($pricegroup->id);
662 my ($self, %params) = @_;
664 # set order number and collect to save
666 foreach my $entry (@{ $self->controller->data }) {
667 next if @{ $entry->{errors} };
669 if ($entry->{raw_data}->{datatype} eq $self->settings->{'order_column'} && !$entry->{object}->ordnumber) {
670 my $number = SL::TransNumber->new(type => 'sales_order',
672 $entry->{object}->ordnumber($number->create_unique());
675 push @{ $objects_to_save }, $entry;
678 $self->SUPER::save_objects(data => $objects_to_save);