Skip to content

Commit 5a4d644

Browse files
author
markus-moser
authored
Update 03_Configuration.md
1 parent 21ec180 commit 5a4d644

File tree

1 file changed

+54
-42
lines changed

1 file changed

+54
-42
lines changed

doc/03_Configuration.md

Lines changed: 54 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -207,17 +207,26 @@ pimcore_customer_management_framework:
207207
- countryCode
208208
- idEncoded
209209

210-
# TODO add description here
210+
# Configuration of filters in the customer list view
211211
filter_properties:
212+
# Filter fields which must match exactly
212213
equals:
213214
id: o_id
214215
active: active
216+
217+
# Searched fields in customer view search filters
218+
# (enhanced search syntax (AND/OR/!/*...) could be used in these fields)
215219
search:
220+
# email search filter
216221
email:
217222
- email
223+
224+
# name search filter
218225
name:
219226
- firstname
220227
- lastname
228+
229+
# main search filter
221230
search:
222231
- o_id
223232
- idEncoded
@@ -245,62 +254,65 @@ pimcore_customer_management_framework:
245254

246255
duplicates_view:
247256
enabled: true # the feature will be visible in the backend only if it is enabled
248-
# TODO add description here
257+
# Visible fields in the customer duplicates view.
258+
# Each single group/array is one separate column in the view table.
249259
listFields:
250260
- [id]
251261
- [email]
252262
- [firstname, lastname]
253263
- [street]
254264
- [zip, city]
255265

256-
# TODO add description here
266+
# Index used for a global search of customer duplicates.
267+
# Matching field combinations can be configured here.
268+
# See "Customer Duplicates Service" docs chapter for more details.
257269
duplicates_index:
258270
enableDuplicatesIndex: false
259271
duplicateCheckFields:
260272
- firstname:
261-
soundex: true
262-
metaphone: true
263-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
264-
265-
zip:
266-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\Zip
267-
268-
street:
269-
soundex: true
270-
metaphone: true
271-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
272-
273-
birthDate:
274-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\BirthDate::class
273+
soundex: true
274+
metaphone: true
275+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
276+
277+
zip:
278+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\Zip
279+
280+
street:
281+
soundex: true
282+
metaphone: true
283+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
284+
285+
birthDate:
286+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\BirthDate::class
275287

276288
- lastname:
277-
soundex: true
278-
metaphone: true
279-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
280-
281-
firstname:
282-
soundex: true
283-
metaphone: true
284-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
285-
286-
zip:
287-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\Zip
288-
289-
city:
290-
soundex: true
291-
metaphone: true
292-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
293-
294-
street:
295-
soundex: true
296-
metaphone: true
297-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
289+
soundex: true
290+
metaphone: true
291+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
292+
293+
firstname:
294+
soundex: true
295+
metaphone: true
296+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
297+
298+
zip:
299+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\Zip
300+
301+
city:
302+
soundex: true
303+
metaphone: true
304+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
305+
306+
street:
307+
soundex: true
308+
metaphone: true
309+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
298310

299311

300312
- email:
301-
metaphone: true
302-
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
303-
similarityThreshold: 90
313+
metaphone: true
314+
similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
315+
similarityThreshold: 90
304316

305317
dataTransformers:
306318
street: \CustomerManagementFrameworkBundle\DataTransformer\DuplicateIndex\Street
@@ -309,4 +321,4 @@ pimcore_customer_management_framework:
309321
lastname: \CustomerManagementFrameworkBundle\DataTransformer\DuplicateIndex\Simplify
310322
birthDate: \CustomerManagementFrameworkBundle\DataTransformer\DuplicateIndex\Date
311323

312-
```
324+
```

0 commit comments

Comments
 (0)