Email Segmentation Component email-segmentation-component
The Email Segmentation Component uses variables from ÃÛ¶¹ÊÓƵ Campaign to show and hide content based on the recipient of the content.
Usage usage
The Email Segmentation Component allows the content author to hide and show content based on conditions met by variables about the recipient provided by ÃÛ¶¹ÊÓƵ Campaign. In this way, the recipients of the content sees content based on their segmentation.
- The template author can use the design dialog to define which components can be added as segment.
- The content author can use the configure dialog to add components as segments and configure which segments are shown based on ÃÛ¶¹ÊÓƵ Campaign variables.
As an alternative to using the configure dialog, once the content author has added the Email Segmentation Component to a content page, the content author can then drag-and-drop additional components onto the Email Segmentation Components to create new segments.
Version and Compatibility version-and-compatibility
The current version of the Email Segmentation Component is v1, which was introduced with release x of the Email Core Components in October 2022, and is described in this document.
The following table details all supported versions of the component, the AEM versions with which the versions of the component is compatible, and links to documentation for previous versions.
Technical Details technical-details
The latest technical documentation about the Email Teaser Component
Further details about developing Core Components can be found in the Core Components developer documentation.
Configure Dialog configure-dialog
The configure dialog allows the content author to create, rename, and rearrange segments as well as define the active segment. In the Email Segmentation Component, a segment is simply another component that is hidden or shown based on conditions met by the recipient of the content. You can compare it to the Core Components Tab Component, but in the Segmentation Component, only the content of the tab whose conditions are met are shown.
Items Tab items-tab
Use the Add Segment button to open the component selector to choose which component to add as a segment. Once added, an entry is added to the list, which contains the following elements:
-
Icon - The icon of the component type of the segment for easy identification in the list. Mouse over to see the full component name as a tooltip.
-
Condition - The condition that must be met for this segment to be shown to the recipient of the content.
-
The conditions available are defined in the design dialog.
-
Default - Defines the default segment to show if no other conditions are met
-
Custom - Allows the author to define a condition
- The conditions are based on ÃÛ¶¹ÊÓƵ Campaign personalization variables
- See here for ÃÛ¶¹ÊÓƵ Campaign Standard personalization resources.
- See here for ÃÛ¶¹ÊÓƵ Campaign Classic personalization resources.
-
-
Delete - Tap or click to delete the segment from the Email Segmentation Component.
-
Rearrange - Tap or click and drag to rearrange the segments.
Properties Tab properties-tab
-
ID - This option allows controlling the unique identifier of the component in the HTML.
- If left blank, a unique ID is automatically generated for you and can be found by inspecting the resulting content.
- If an ID is specified, it is the responsibility of the author to make sure that it is unique.
- Changing the ID can have an impact on CSS.
Accessibility Tab accessibility-tab
On the Accessibility tab, values can be set for labels for the component.
- Label - Value of an ARIA label attribute for the component
Styles Tab styles-tab-edit
The Email Segmentation Component supports the AEM Style System.
Use the drop-down to select the styles that you want to apply to the component. Selections made in the edit dialog have the same effect as those chosen from the component toolbar.
Styles must be configured for this component in the design dialog in order for the tab to be available.
Select Panel select-panel
The content author can use the Select Panel option on the component toolbar to change to a different segment for editing as well as to easily rearrange the segments.
Once selecting the Select Panel option in the component toolbar, the configured segments are displayed as a drop-down.
- The list is ordered by the assigned arrangement of the segments and is reflected in the numbering.
- The component type of the segment is displayed first, followed by the description of the segment in lighter font.
- Tapping or clicking an entry in the dropdown, switches the view in the editor to that segment.
- The segments can be rearranged in-place by using the drag handles.
Design Dialog design-dialog
The design dialog allows the template author to define which components can be added as segments to the Email Segmentation Component as well as define which custom styles are available to the content author.
Allowed Components Tab allowed-components-tab
The Allowed Components tab is used to define which components can be added as segments to the Email Segmentation Component by the content author.
The Allowed Components tab functions in the same way as the tab of the same name when defining the policy and properties of a Layout Container in the Template Editor.
Styles Tab styles-tab
The Email Segmentation Component supports the AEM Style System.
Defined Conditions Tab defined-conditions
Using the Defined Conditions tab, the template editor can define which conditions are available to the content author to select when creating segments.
Tap or click the Add button to create new conditions.
-
Segment Condition Name - A description of the condition
-
Segment Condition - The actual condition that must be met, based on ÃÛ¶¹ÊÓƵ Campaign personalization variables
- See here for ÃÛ¶¹ÊÓƵ Campaign Standard personalization resources.
- [See here for ÃÛ¶¹ÊÓƵ Campaign Classic personalization resources.](/docs/
-
Remove - Tap to click to remove the condition
-
Rearrange - Tap or click and drag to rearrange the order of the conditions