pimcore/customer-data-framework

Customer Data Framework community bundle adds capability for management of customer data to Pimcore.

title
Customer Management Framework

Pimcore Customer Management Framework

Pimcore allows to manage any kind of data - unstructured, digital assets and structured content. The most obvious structured content is product data and all data related to products like categories, technologies, brands, etc. The built-in E-Commerce Framework supports building e-commerce applications and managing transactional data like orders. The third big group of structured data besides products and transactions is customer data.

The Customer Management Framework (CMF) for Pimcore adds new functionality for customer data management, segmentation, personalization and marketing automation. It allows aggregating customer data and user profiles, enriching data, linking social profiles, building audience segments, triggering events, personalizing experience, executing marketing automation, and much more.

Like Pimcore itself and the E-Commerce-Framework, the CMF is also a Framework for developers to develop customer management solutions and is tightly integrated into the Pimcore Core functionality.

Provided Functionality in a Nutshell

• Customer Data Management based on Pimcore Data Objects.
• Storage of Customer Activities from different data feeds.
• Customer Segmentation based on data, activities and other criteria.
• Duplicate detection and merging.
• Enhancement of Pimcore's on-site personalization.
• Marketing Automation with built-in rule engine and triggers.
• Default integration to external newsletter systems like MailChimp.
• Rest API for integration of external systems for data import or export.

For a first impression have a look at our Demo. For more complex solutions have a look at our case studies.

Documentation Overview

The following sections provide shortcuts into the documentation to start working with the Customer Management Framework (CMF) for Pimcore:

• See the Getting Started section for an overview of the CMF Framework architecture or information about the installation process.
• See the Customer-Related Data section for details about the management of customer-related data with the CMF Framework.
• See the Provided Services section for documentation about services provided by the CMF Framework.

Getting Started

• Architecture Overview
• Installation and Configuration

Customer-Related Data

• Working with Customers
• Working with Activities (ActivityManager, ActivityStore, ActivityView)
• Working with Customer Segments

Provided services

• Customer Duplicates Service
• Built-In Marketing Automation Engine
• Newsletter System Integration
• Rest API Webservice
• Integration with Pimcore Targeting Engine

Contributing and Development

For details see our Contributing guide.

customer-data-framework's Issues

Add an alternative version for displaying segment relations

Sometimes it may be prefered to just see the segment name (and group) instead of the full path in the customer segment relation fields. An optional path formatter class could help here.

[Template Export] Prevent MailChimp merge tags from being absolutized when used in href

for

• *|UNSUB|*
• *|FORWARD|*
• *|UPDATE_PROFILE|*

Add metadata items to activity store entries

Activity store entries should provide a possibility to store metadata items. This could be usefull for example for segment builders to store/check whether a concrete activity was already processed.

[Configuration] typo in newsletterQueueImmediateAsyncExecutionEnabled

Add a CustomerSaveHandler to allow overwriting fields by other field values

Sometimes it could be helpfull to separate the customer address data into multiple tabs.

For example:
Tab customer master data:

• firstname
• lastname
• street
• zip
• city

Tab customer profile data:

• firstname
• lastname
• street
• zip
• city

A logic could be needed to for example overwrite the master data fields with the values of the profile data fields only if the master data fields are empty. An additional CustomerSaveHandler could be helpfull to create these kind of field dependencies.

Important: the field value in the master data tab should be overwritten only when the profile data tab field value actually changed but the master data tab did not change.

DefaultCustomerProvider getList should consider class overriding.

Currently the getList method of the DefaultCustomerProvider always returns the default Pimcore Listing. It should consider defined class_overrides

[SegmentBuilder] move segmentBuilderMaintenance execution to cmf specific maintenance console command

currently it runs with the pimcore maintenance.

[DefaultCustomerProvider] Consider Pimcore class overrides for customer class

Customer CSV exporter - take advantage of field definition getForCsvExport() methods

[DuplicatesIndex] make sure that found duplicates are removed when customer object is deleted

Pimcore Newsletter AddressSourceAdapter mapping selectable segments to email addresses

This is deemed necessary.

[Duplicates Index] Cleanup Duplicate Index table from zombie entries

Create separate component for extracting segments and segment application counters of customer data objects

Extracting customer segments and segment application counters from customer objects is a quite often needed task and relatively complex.

Therefore all related logic should be extracted/added into a separate service.

Typo: treshold > threshold

treshold should be renamed into threshold

[DuplicatesIndex] ignore duplicate check when merging customer

e.g. when copying name field while merging customers, the merged customer cannot be saved since hard duplicate check throws an exception

[Targeting] Missing check if visitorinfo has targetgroup assigment

[Targeting] matched variables of has segment must contain selected segment only

not all assigned segments

JSON datatype instead of dynamic columns

Currently MariaDB is needed to install this plugin.
Meanwhile most RDBMS (MySQL 5.7, Postgres 9.3, AWS Aurora) support a JSON datatype. What do you think of using this instead of dynamic columns?

Migrate TermSegmentBuilder report to new scheme for integration

see https://pimcore.com/docs/5.0.x/Tools_and_Features/Custom_Reports.html

[SegmentAssignment] saving object when class assignment not active throws error in console

TypeError: Cannot read property 'breaksInheritance' of undefined
at klass.saveSegmentAssignments (startup.js?_dc=1:284)
at klass.preSaveObject (startup.js?_dc=1:279)

[Installer] ObjectBricks OAuth1Token and OAuth2Token are not added

[Doc] Add meaningful comments to actitivy::cmftoArray

this is the method that defines, what data is stored in activity store?

Add customer CSV import feature based on Pimcore core importer

Environment Column Missing in plugin_cmf_actiontrigger_queue

[Migrations] add migration to install mysql functions for segment assignemt

Saved Searches

• add/remove segment filters in filter view

  • edit button in filter view opens simple list of checkboxes to activate and deactivate segment filters for current view
    

• save current filter

  • enter name + optionally 'add short cut'
  • saves current active segment filters
  • saves current filter input
  • saved searches can be opened in dialog or via shortcut as subitem from 'customers' menu entry - similar to advanced object search (see screen)
    

• share filter

  • shares saved filter with user or user group
  • sharing logic same as grid configuration in pimcore backend or advanced object search
  • additional option for 'read-only'

[Installer] migrate user right keys and install admin translations for user rights

• user right keys are currently longer then the allowed length of 50 chars
• in the user admin gui the keys are outputed without a translated name

[SegmentAssignment] Decouple saving segment assignment from element save

Like with tags, segment assignment should be saved independently from element save.
Save it on the fly as soon as the grid changes.

right now saving of elements does not work on

• document folders at first try (in subsequent tries it works?!)
• assets in general

[Targeting] Add Action to Apply Target Groups from Segments

Search for found duplicate customers

It would be nice if there would be a search possibility for found possible duplicate customers.

[Targeting] Add condition for logged-in customers

[SegmentAssignment] Inheritance does not work

at least the list of inherited segments is empty on child documents

Consolidate customer save manager save options

The customer management framework offers a lot of hooks and mechanisms when the save() method of a customer gets called:

• customer validation
• on customer save segment builders
• add to segment builder queue
• customer save handlers
• automatic object naming scheme
• newsletter queue

The SaveManager offers options for disabling all of them if needed but as there are quite a lot of options now and there might be added more in the future the handling of these save options needs to be streamlined.

Therefore the following changes should be done:

• Introduce separate SaveOptions class which holds the state of all save options
• Add method saveWithOptions() to the CustomerSaveManagerInterface
• Add saveWithOptions() and getSaveManager() methods directly to the abstract customer.
• Add a legacy trait with deprecated methods which ensures backward compability. All of these methods need to be removed from the CustomerSaveManagerInterface. This trait might be removed in the future.
• Update docs with examples how to use these new save options.

CMF Funktionalitätserweiterung - Zielgruppen-Infor auf Dokument

Im CMF besteht die Möglichkeit für jede angelegte Zielgruppe ein separates Dokument zu erstellen, bzw. die Default-Version auf die Zielgruppe anzupassen. Wechselt der Redakteure zwischen diesen Zielgruppen-Dokumenten, sollte im Dokument übersichtlich angezeigt werden, auf welchem Zielgruppen-Dokument sich der Redakteur befindet.

Mit der Bitte um Erweiterung wenn möglich.

Danke und lG Markus

Access control for documents

We would like to have documents which are only accessible for certain target groups. At the moment it is only possible to customize a document based on a target group but you cannot make a document accessible only for certain target groups. Or did we miss something?

We imagine a document setting to specify which target groups have access to the document. If the current user's target group does not have access, the document is neither shown in the navigation nor is it accessible via URL.

If this is not possible at the moment, we could invest some time to implement it but wanted to discuss this feature beforehand if you think it is desirable.

[Activities] Add possibility to include links to Pimcore elements (e.g. objects) in activity detail view

Customer with MailchimpAwareCustomerInterface

Hi,
If the MailChimp sync feature is enabled, the Customer data object class needs to implement the MailchimpAwareCustomerInterface.

For the MailChimp sync feature you wrote that we have to implement the MailchimpAwareCustomerInterface in the Customer data object. When I do this, it throws an error: Fatal error: Class Pimcore\Model\DataObject\Customer cannot extend from interface ...

Pimcore 5.2.0

make class name of customer configurable

especially for JS and attaching activity view to editor, like here:
https://github.com/pimcore-partner/customer-data-framework/blob/master/src/Resources/public/js/startup.js#L148

Customer management menu not visible

Hi,

I successfully activated/installed the bundle, but I cant see the item menu on left side in pimcore 's dashboard.
There is a special manipulation to activate it on menu ?

Pimcore 5.2.1

Thanks,

Menu not showing >> settings-json 500 error & Cannot read property 'duplicatesViewEnabled' of undefined

Hi,

I tried to install the framework, but after the activation and refreshing, the menu won't show up.

Instead I get a 500 error for /admin/customermanagementframework/helper/settings-json which results in more errors e.g.: TypeError: Cannot read property 'duplicatesViewEnabled' of undefined

Did I miss something here?

Customer Listing needs to consider Pimcore Permissions

not visible users should also not be shown in customer listing

Mailchimp: Double-Opt-In-Mail multilanguage

CustomerLanguage should be added via HTTP-Header in api calls.

see drewm/mailchimp-api#148

[SegmentAssignment] translations are missing

[SegmentAssignment] Activating Segment Assignment on Object Folders not working

Segment Assignment Tab does not appear

SSO Login for not-active users must not be possible

New user should be created?

[Activities] Cleanup after customer is deleted

[Installer] make sure already existing classes are not overwritten

Invalid argument for foreach() SegmentExporter

In the CustomerManagementFrameworkBundle\Newsletter\ProviderHandler\Mailchimp\SegmentExporter.php in Line 425 is it possible to get an empty array, so it should be checked before the foreach() like:
if(is_array($result['categories'])) {
...
}

[Activities] Add possibility to make E-Commerce-Framework Orders to activities

Include Profiling Consent

• Add getProfilingConsent() to abstract customer
• Add option to consider this setting in
  • targeting rule assign target group
  • targeting rule track segment
  • customer automation rule add segment
  • customer automation rule add tracked segment
  • customer automation rule add target group segment