Update 03_Configuration.md

pimcore · Oct 18, 2017 · 5a4d644 · 5a4d644
1 parent 21ec180
commit 5a4d644
Showing 1 changed file with 54 additions and 42 deletions.
diff --git a/doc/03_Configuration.md b/doc/03_Configuration.md
@@ -207,17 +207,26 @@ pimcore_customer_management_framework:
                    - countryCode
                    - idEncoded
 
-        # TODO add description here      
+        # Configuration of filters in the customer list view      
         filter_properties:
+            # Filter fields which must match exactly
             equals:
                 id:                  o_id
                 active:              active
+
+            # Searched fields in customer view search filters
+            # (enhanced search syntax (AND/OR/!/*...) could be used in these fields)
             search:
+                # email search filter
                 email:
                   - email
+
+                # name search filter
                 name:
                   - firstname
                   - lastname
+
+                # main search filter
                 search:
                   - o_id
                   - idEncoded
@@ -245,62 +254,65 @@ pimcore_customer_management_framework:
 
         duplicates_view:
             enabled: true # the feature will be visible in the backend only if it is enabled
-            # TODO add description here
+            # Visible fields in the customer duplicates view. 
+            # Each single group/array is one separate column in the view table.
             listFields:
               - [id]
               - [email]
               - [firstname, lastname]
               - [street]
               - [zip, city]
 
-        # TODO add description here
+        # Index used for a global search of customer duplicates. 
+        # Matching field combinations can be configured here.
+        # See "Customer Duplicates Service" docs chapter for more details.
         duplicates_index:
             enableDuplicatesIndex: false
             duplicateCheckFields:
                 - firstname:
-                  soundex: true
-                  metaphone: true
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
-                
-                zip:
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\Zip
-                
-                street:
-                  soundex: true
-                  metaphone: true
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
-                
-                birthDate:
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\BirthDate::class
+                      soundex: true
+                      metaphone: true
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
+
+                  zip:
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\Zip
+
+                  street:
+                      soundex: true
+                      metaphone: true
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
+
+                  birthDate:
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\BirthDate::class
 
                 - lastname:
-                  soundex: true
-                  metaphone: true
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
-                
-                firstname:
-                  soundex: true
-                  metaphone: true
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
-                
-                zip:
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\Zip
-                
-                city:
-                  soundex: true
-                  metaphone: true
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
-                
-                street:
-                  soundex: true
-                  metaphone: true
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
+                      soundex: true
+                      metaphone: true
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
+
+                  firstname:
+                      soundex: true
+                      metaphone: true
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
+
+                  zip:
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\Zip
+
+                  city:
+                      soundex: true
+                      metaphone: true
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
+
+                  street:
+                      soundex: true
+                      metaphone: true
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
 
 
                 - email:
-                  metaphone: true
-                  similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
-                  similarityThreshold: 90
+                      metaphone: true
+                      similarity: \CustomerManagementFrameworkBundle\DataSimilarityMatcher\SimilarText
+                      similarityThreshold: 90
 
             dataTransformers:
               street: \CustomerManagementFrameworkBundle\DataTransformer\DuplicateIndex\Street
@@ -309,4 +321,4 @@ pimcore_customer_management_framework:
               lastname: \CustomerManagementFrameworkBundle\DataTransformer\DuplicateIndex\Simplify
               birthDate: \CustomerManagementFrameworkBundle\DataTransformer\DuplicateIndex\Date
 
-```
+```