List Views

CMF provides two additional views for visualizing customer data in Pimcore Studio.

Customer View

The customer view lists customers with filter and export functionality, plus a few configuration options. Open it via the main menu in Pimcore Studio; it lists all customers matching the filter criteria regardless of their location in the object tree. Users only see customers they have permission to access.

The view has "Customer" filters and "Segments" filters. Choose between "or" (match any) and "and" (match all) conditions within each group; the condition between the customer and segments filter groups is always "and".

Sort the list by clicking the column headers.

Configuration Options

• Search Columns: CMF configuration controls which columns are considered when searching and filtering the customer list.

• Filter for Segments: the customer view also filters by assigned segments. Configure this on the CustomerSegmentGroup objects by activating the Show as Filter option. Change the segment sort order with Filter sort order (high to low).

  

• Exporters: configure exports for all customers currently shown in the customer view.

  

  Configure exports in the CMF configuration with a name, an icon, an exporter class, and the properties to export. The exporter class is a PHP class that defines the export format; CMF ships implementations for csv and xlsx. You can configure multiple exporters.

In addition to the global customer view, the CustomerSegment object edit view adds a tab listing customers that have the segment assigned:

Additional filter settings are hidden when viewing customers of a segment directly.

Selecting a customer in the list opens that customer's detail view. By default, this is a basic view showing all customer attributes. Provide a custom view by overriding the cmf.customer_view service in the Symfony container and overriding getDetailviewTemplate(CustomerInterface $customer), which returns the path to the customer's detail template (by default @PimcoreCustomerManagementFramework/admin/customers/partials/detail.html.twig).

The same service also lets you customize how a customer appears in the customer listing: override getOverviewTemplate(CustomerInterface $customer) and return the path to your custom template.

Advanced Filter Settings

Save a configured filter for reuse. Advanced filter settings are available only when accessing the customer view via the menu; they are hidden when viewing customers of a specific segment. Every user can add and update their own filters. A user with the CMF Customer Filter-Admin permission (plugin_cmf_perm_customerview_admin) can also update filters shared with them. Sharing a filter with other users additionally requires the Share configurations permission (share_configurations); see the Installation chapter's permission table for the full list of CMF permissions. A user with Share configurations can share their own filters, or re-share filters that were shared with them.

Change the available segments via the Edit button in the filter section's segments area.

Creating New Filters

Every user can select, save, and update their own filters by setting filter criteria for customer fields in the Customer section and selecting segments in the Segments section. Clicking Save Filter opens a dialog where a user with the Share configurations permission can also share the filter with other users and roles.

Set Read Only to lock the filter's criteria against further changes. Set Shortcut Available to make the filter available directly via the menu, for the user and all shared users and roles. Saving a filter automatically selects it in the filter selection. When editing an existing filter, the Save & Share Filter or Save Filter dialog has an additional button to update that specific filter definition.

Sharing Filters

Users access filters shared with them either through the customers menu, by selecting the filter, or directly via the menu if Shortcut Available is set for the filter.

A user with the Share configurations permission can re-share filters shared with them by clicking Share Filter and adding users or roles, but cannot remove existing users or roles from the filter definition. Only a user with the CMF Customer Filter-Admin permission, or the filter's owner, can remove existing shares by updating the filter definition.

Creating a New Customer Object

A button next to the filter selection, in the Filters section, quickly adds a new customer. It is available only if the user has save permission on the temporary new-customer directory configured under pimcore_customer_management_framework -> customer_provider -> newCustomersTempDir (see Configuration). Clicking New Customer creates and opens a new customer in that directory. When the automatic naming scheme is enabled, saving the customer moves it to its corresponding directory.

Activity View

The activity view shows an overview of all activities for a customer, as an additional tab in the customer object editor.

Each activity also has a detail page.

Configuration Options

• Activity details in the list view: the activity implementation's cmfGetOverviewData(ActivityStoreEntryInterface $entry) method defines the information shown for an activity in the list. It should return an associative array of all data to show.
• Activity detail page: configure its content in one of two ways:
  1. Implement cmfGetDetailviewData(ActivityStoreEntryInterface $entry), returning an associative array of data. By default, this data is shown as a two-column list.
  2. Implement cmfGetDetailviewTemplate(ActivityStoreEntryInterface $entry), returning the path to a template file to implement a fully custom detail page.