Customer tags #3118

DamianoSilverhand · 2021-02-27T11:50:49Z

@jekkos this pull request adds Customer custom fields, hereby named as Tags, with the same functionality as Item Attributes. But as of issue #3111, works needs to be done on pulling the tags from the database and displaying them in the customer view.
Major changes include :

New Migration to include new Tags module
Customer CSV import and file generation refactored to include Tags.

…include data row for Tags

… import functions to allow tags in import file , created customer import csv helper and added Tag input on Customer creation/editing form

… migrations for Tags module

… customer CSV import

jekkos

Changeset looks good overall, I'll do a more thorough review a bit later on. We'll have to merge the work from @objecttothis first to have the import improvements. Once that is done we can polish this one up a bit and reuse some common logic (like the import validation checks).

Thanks already for the work done here.

jekkos · 2021-02-28T11:35:21Z

application/controllers/Customers.php

+	// 					}
+	// 				}
+	// 				else
+	// 				{


Is this new code or old code commented out?

I guess this is unused so it can be removed?

@jekkos yes the commented code is the original code involved with csv import and is unused in this PR.

jekkos · 2021-02-28T11:35:56Z

application/controllers/Customers.php

 		$name = 'import_customers.csv';
-		$data = file_get_contents('../' . $name);
-		force_download($name, $data);
+		$allowed_tags = $this->Tag->get_definition_names(FALSE);


I like the naming maybe even better then 'attributes'. However currently it's not really clear that attributes are linked to items and tags to customers from the naming only.

@jekkos which naming should be implemented, should I keep the tags as they are or change to customer_tags or customer_attributes as suggested by @objecttothis ?

I need to clarify, since my position changed below after reading some of @jekkos comments. My recommendation is to change it to person_tags:

The naming scales well to use this in suppliers and employees.

It's shorter than person_attributes or customer_attributes.

We can later refactor attributes to be item_tags instead of attributes.

The GUI everywhere should be just tags since the context will make it clear about which tags we are talking about... although we will need to think through how we want to define tags. Once it gets scaled to employees and suppliers then just probably have a multi-select dropdown allowing you to choose which types of "person" the tag will apply to.

@objecttothis are you fine to make it person_attributes as @daN4cat ? Let's make sure we're on the same page here then.

Yeah, I'm concerned about tags being a semantic set / grouping concept.

Ok person_attributes it is.

Will start working on the recommended changes, meaning I will have to create a new branch person_attributes for my next PR

@objecttothis are you fine to make it person_attributes as @daN4cat ? Let's make sure we're on the same page here then.

No complaint here. Sorry for not being able to respond earlier.

jekkos · 2021-02-28T11:36:52Z

application/controllers/Customers.php

-							'zip'			=> $data[10],
-							'country'		=> $data[11],
-							'comments'		=> $data[12]
+							'phone_number'	=> $line['Phone Number'],


Ok good to use the key names to identify the fields here

Yes, in fact it's better to refactor the rest so all of them are using the key names. This provides a few advantages.

If the user moves columns around in their CSV it will still process them properly (as long as they don't change the names of columns.

It's easier to read in the code.

jekkos · 2021-02-28T11:37:49Z

application/controllers/Customers.php

-						$failCodes[] = $i;
+						$failed_row = $i+1;
+						$failCodes[] = $failed_row;
+						log_message("ERROR","CSV Item import failed on line ". $failed_row .". This customer was not imported.");


I guess we show a popup as well in the end? Should be customer import not item

jekkos · 2021-02-28T11:38:14Z

application/controllers/Customers.php


 				if(count($failCodes) > 0)
 				{
 					$message = $this->lang->line('customers_csv_import_partially_failed') . ' (' . count($failCodes) . '): ' . implode(', ', $failCodes);


Good idea to do the rollback in case a failure occurs

jekkos · 2021-02-28T11:39:09Z

application/controllers/Customers.php

+					$dropdown_values 	= $this->Tag->get_definition_values($tag_data['definition_id']);
+					$dropdown_values[] 	= '';
+
+					if(in_array($tag_value, $dropdown_values) === FALSE && !empty($tag_value))


not sure if this code can be extracted / reused (as we might have similar checks now in the item import). Maybe @objecttothis after we'll merge your PR?

jekkos · 2021-02-28T11:53:06Z

application/helpers/importcustomer_helper.php

+ * @param	object $file_handle	File handle to check
+ * @return	bool				Returns TRUE if the BOM exists and FALSE otherwise.
+ */
+function customer_bom_exists(&$file_handle)


This helper can probably be shared between item and customer import. I gues the latter will be merged first

Agreed. Reduces code duplication. The item import changes need to be imported before this PR.

Ok we can leave this open for now, will need to be resolved once @objecttothis changes are in.

jekkos · 2021-02-28T11:55:59Z

application/migrations/sqlscripts/3.3.4_customer_tags.sql

+ UNIQUE `tag_links_uq1` (`tag_id`, `definition_id`, `person_id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+
+


from a db point of view I suppose it's more simple to do it this way.. I would rename the module to sth like Customer Tags and then Attributes can be named 'Item tags' just for consistency

@jekkos I'm fine with changing attributes to tags, which would make the variable names more brief, but I would advocate that this change be implemented on the People level so that tags could later be applied to Suppliers and Employees, even if this PR only implements them for customers ATM. I think the naming then could be people_tags and then we have a technical debt for someone to refactor attributes to item_tags. Thoughts?

If we use the person table to link the tags to then it's just a matter of running the queries in those controllers as well. I think that for this change that's enough.. Link it to the person table and then have it functional in the customer module only. If you get the database model right, you'll be able to rework and factor out the common code to use it in employees and suppliers as well?

objecttothis · 2021-03-01T08:47:00Z

@jekkos this pull request adds Customer custom fields, hereby named as Tags, with the same functionality as Item Attributes. But as of issue #3111, works needs to be done on pulling the tags from the database and displaying them in the customer view.
Major changes include :
1. New Migration to include new Tags module

2. Customer CSV import and file generation refactored to include Tags.

I haven't looked at the code yet, but a couple of thoughts on design. All of these thoughts are IMO:

This needs to be implemented at the person level, not just the customer level. The reason is that you want to be able to add attributes to the Suppliers, Customers and Employees. All of those are at the People level. It's OK if we only do customers for now, but this needs to be designed in such a way as to allow the easy expansion to Suppliers and Employees.
The database needs to use a separate set of definition, attribute and link tables from item attributes.
I think we need to avoid overcomplication of naming conventions and just stick to "Item Attributes" and "People Attributes". On the UI, they can just be called attributes and then the business logic needs to differentiate depending on whether we are working with people or items.

objecttothis

For clarity, my comments are all IMO and open for discussion on them. @jekkos and @daN4cat feel free to override them. I feel strongly about the naming conventions, but then again, I feel strongly about most things ;)

objecttothis · 2021-03-01T12:36:58Z

application/config/autoload.php

 	'Tax_code',
-	'Tax_jurisdiction'
+	'Tax_jurisdiction',
+	'Tag'


We should stick with the current naming and call this person_attribute instead of tag IMO. @jekkos @daN4cat thoughts?

Yes or person_tags in this case? I must say that I like the fact that it's shorter, especially if we have to identify to which module it belongs?

Tags tend to be used to create semantic sets, we risk of mixing up terminology.
What about leaving attribute?

Or person_attribute

Also fine, I mostly prefer shorter naming, but might be less correct as @daN4cat says here.

objecttothis · 2021-03-01T12:43:27Z

application/helpers/importcustomer_helper.php

+ * @param	object $file_handle	File handle to check
+ * @return	bool				Returns TRUE if the BOM exists and FALSE otherwise.
+ */
+function customer_bom_exists(&$file_handle)


Agreed. Reduces code duplication. The item import changes need to be imported before this PR.

objecttothis · 2021-03-01T12:47:25Z

application/migrations/20210226124200_customer_tags.php

+
+	public function down()
+	{
+


This down function needs to be completed... I'm guessing it would just be a script that deletes these tables.

objecttothis · 2021-03-01T12:49:47Z

application/migrations/sqlscripts/3.3.4_customer_tags.sql

+ UNIQUE `tag_links_uq1` (`tag_id`, `definition_id`, `person_id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+
+


@jekkos I'm fine with changing attributes to tags, which would make the variable names more brief, but I would advocate that this change be implemented on the People level so that tags could later be applied to Suppliers and Employees, even if this PR only implements them for customers ATM. I think the naming then could be people_tags and then we have a technical debt for someone to refactor attributes to item_tags. Thoughts?

objecttothis · 2021-03-01T12:52:26Z

application/views/tags/item.php

+				echo form_hidden("tag_ids[$definition_id]", $definition_value['tag_id']);
+				$tag_value = $definition_value['tag_value'];
+
+				if ($definition_value['definition_type'] == DATE)


IMO these need to be in a switch statement rather than a bunch of else if statements... if not, we need to at minimum modify this to use the === operator.

objecttothis · 2021-03-03T13:44:19Z

Yeah that's fine. I don't have a hangup on person_tags, but person_attributes is fin with me too. We may not even need to refactor attributes to item_attributes if we go with person_attributes. Get Outlook for Android<https://aka.ms/ghei36>

________________________________ From: jekkos <[email protected]> Sent: Wednesday, March 3, 2021 12:08:49 PM To: opensourcepos/opensourcepos <[email protected]> Cc: objecttothis <[email protected]>; Mention <[email protected]> Subject: Re: [opensourcepos/opensourcepos] Customer tags (#3118) @jekkos commented on this pull request.

________________________________ In application/controllers/Customers.php<#3118 (comment)>:

/*

Customers import from csv spreadsheet */ public function csv() { $name = 'import_customers.csv'; - $data = file_get_contents('../' . $name); - force_download($name, $data); + $allowed_tags = $this->Tag->get_definition_names(FALSE); @objecttothis<https://github.com/objecttothis> are you fine to make it person_attributes as @daN4cat<https://github.com/daN4cat> ? Let's make sure we're on the same page here then. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#3118 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AEI2X243ZFU2UKM3T7FJQ3TTBXVBDANCNFSM4YJ3XYLQ>.

objecttothis · 2021-03-05T06:58:20Z

application/controllers/Customers.php


-					$consent = $data[3] == '' ? 0 : 1;
+					//check for consent in file upload, y == yes , empty field == no
+					$consent = $line['Consent'] == '' ? 0 : 1;


This functionality wasn't in there before so if you don't want to include it then that's fine, but you might take a look at how I've handled true/false/0/1/NULL columns in item imports from #3029. I'm not sure, but current implementation here won't be able to handle true/false/TRUE/FALSE/NULL, but instead translating them all to 1.

objecttothis · 2021-03-05T07:05:57Z

application/controllers/Customers.php

+		force_download($name, $data, TRUE);
 	}

 	public function csv_import()


with #3029 I have a function in the importfile_helper called get_csv_file(). You'll want to use that here to take advantage of code_reuse, and that I've done extensive speed optimizations on that function to reduce time it takes to injest large files. It's not as good of a system as an injest queue would be, but we don't currently have that in the code.

…moved it from employees, customers and suppliers forms

…include data row for Tags

… import functions to allow tags in import file , created customer import csv helper and added Tag input on Customer creation/editing form

… migrations for Tags module

… customer CSV import

…moved it from employees, customers and suppliers forms

DamianoSilverhand · 2021-04-16T07:15:24Z

@jekkos @objecttothis @daN4cat I am kindly requesting that this PR be closed in favor of #3161 , branch person attributes, with reworked changes and additions and extension of person attributes to Suppliers and Employees.

DamianoSilverhand added 5 commits February 27, 2021 09:04

Created MVC structure for Customer Tags, modified tabular helpers to …

dc0506a

…include data row for Tags

Modified Customer controller to include Tags, refactored Customer CSV…

830bf20

… import functions to allow tags in import file , created customer import csv helper and added Tag input on Customer creation/editing form

Added language support for Tags module in en-US

d9bf2b7

Set new Tags module and customer import help to autolaod, created new…

b3d81fe

… migrations for Tags module

Added Customer Tags to Customer table headers, created data check for…

1b42a5b

… customer CSV import

jekkos requested review from daN4cat and objecttothis February 27, 2021 21:32

jekkos requested changes Feb 28, 2021

View reviewed changes

objecttothis requested changes Mar 1, 2021

View reviewed changes

objecttothis reviewed Mar 5, 2021

View reviewed changes

jekkos mentioned this pull request Mar 22, 2021

Custom Fields for Customers #2985

Closed

DamianoSilverhand added 3 commits March 27, 2021 12:25

changed customer tags MVC into person attributes

083a116

added person attributes to customers module

161caae

extended person attributes to employees module

264ceb9

DamianoSilverhand mentioned this pull request Mar 27, 2021

Display Customer Attributes (Tags/Custom fields) in View #3111

Open

DamianoSilverhand added 4 commits March 27, 2021 14:07

extended person attributes to suppliers module

ae28904

attached person attribute input form to people basic info form and re…

4b0ee80

…moved it from employees, customers and suppliers forms

merged import customer_helper funtions into imporfile_helper

cc93352

removed deleted importcustomer helper from autoload

c492d99

DamianoSilverhand requested review from jekkos and objecttothis March 30, 2021 15:27

jekkos mentioned this pull request Apr 6, 2021

Add New/Custom Customer Columns #1193

Closed

DamianoSilverhand added 5 commits April 15, 2021 12:42

Created MVC structure for Customer Tags, modified tabular helpers to …

d0d0aff

…include data row for Tags

Modified Customer controller to include Tags, refactored Customer CSV…

e4b338e

… import functions to allow tags in import file , created customer import csv helper and added Tag input on Customer creation/editing form

Added language support for Tags module in en-US

f9c4c71

Set new Tags module and customer import help to autolaod, created new…

abd3e97

… migrations for Tags module

Added Customer Tags to Customer table headers, created data check for…

8beec93

… customer CSV import

DamianoSilverhand added 9 commits April 15, 2021 12:42

changed customer tags MVC into person attributes

71a8319

added person attributes to customers module

d3ac187

extended person attributes to employees module

36e6add

extended person attributes to suppliers module

98313bc

attached person attribute input form to people basic info form and re…

dc07ec9

…moved it from employees, customers and suppliers forms

merged import customer_helper funtions into imporfile_helper

6d79e66

removed deleted importcustomer helper from autoload

e7f51dd

error collection on undefined person variable in tabular_helper

2ea92fa

rebased customer_tags branch on to latest master

091e294

DamianoSilverhand force-pushed the customer_tags branch from 739941b to 091e294 Compare April 15, 2021 11:21

objecttothis closed this Apr 16, 2021

DamianoSilverhand deleted the customer_tags branch April 16, 2021 10:40

jekkos added a commit that referenced this pull request Jun 7, 2021

Do not run build again for tagged commits (#3118)

0bad03e

		UNIQUE `tag_links_uq1` (`tag_id`, `definition_id`, `person_id`)
		) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;

Uh oh!

Customer tags #3118

Customer tags #3118

Uh oh!

Conversation

DamianoSilverhand commented Feb 27, 2021

Uh oh!

jekkos left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

objecttothis Mar 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jekkos Mar 1, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

objecttothis commented Mar 1, 2021

Uh oh!

objecttothis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

objecttothis Mar 1, 2021 •

edited

Loading

jekkos Mar 1, 2021 •

edited

Loading