As a content manager, I want the order of collections variations to determine the priority in which they're presented to the users in the matching segments

• Type: Story
• Status: Closed
• Priority: Minor
• Resolution: Completed
• Affects Version/s: None
• Fix Version/s: Master
• Component/s: Collections > Collections Personalization
• Labels:
  • fc_22_01
  • fc_22_02
  • liferay-update-dxp-3-7413
  • pt-app-security-review
  • pt-upgrade-review
• Epic Link: tango-collections-variations-prioritization
• Sprint: TANGO | #69 DEV | Oct29-Nov19, TANGO | #70 DEV | Nov19-Dec10, TANGO | #71 DEV | Dec10-Jan14, TANGO | #72 DEV | Jan14-Feb04, TANGO | #73 DEV | Feb04-Feb25
• Git Pull Request: https://github.com/liferay-tango/liferay-portal/pull/1992

Background

Collections are sets of content items that you can use to group and filter information. You can create Personalized Variations of a Collection in order to display different sets of content to different subsets of users. A Collection can have several Variations. Each Variation is associated to one segment. There is a default Variation called "Anyone" which encompasses all users that do not belong to any specified Variation.

For more information about Collections see:  About Collections and Collection Pages
For more information about Personalized Variations see: Personalizing Collections

Motivation

See PTR-2036 - Make Personalized Variations predictable for Content Sets.

With the newly added capabilities to order Variations (LPS-101448) and Combine Assets for All Segments (LPS-108368), we must now ensure that assets in the Asset Publisher and Collection Display Fragment are displayed accurately, according to their Variation. 

Requirements

• Variations will be prioritize from the top of the list to the bottom (Variations at the top will have the highest priority, Variations at the bottom will have the lowest). 
• Any Variation below the default "Anyone" will not be considered. 
• When a user belongs to multiple segments and the "Combine Assets" configuration is disabled:
  • they will only see assets associated with the highest priority variation they belong to. 
    • this applies to both Manual and Dynamic Collections.
• When a user belongs to multiple segments and the "Combine Assets" configuration is enabled for a Dynamic Collection:
  • they will see all assets associated with all segments they belong to - except those belonging to the "Anyone" Variation. 
  • they will not see any duplicated assets (for example: if an asset exists in multiple segments that the user belongs to, they will only see that asset once). 
  • the assets shown to the user will be ordered according to:
    1. The asset priority (different from the variation priority)
    2. The creationDate of the asset
    • Note: Originally we had planned on ordering the assets by the priority of the variation they belong to (similarly to how Manual Collections are ordered), however we ran into technical limitations which led to this ordering. For more details see LPS-147233.
• When a user belongs to multiple segments and the "Combine Assets" configuration is enabled for a Manual Collection:
  • they will see all assets associated with all segments they belong to - except those belonging to the "Anyone" Variation. 
  • they will not see any duplicated assets (for example: if an asset exists in multiple segments that the user belongs to, they will only see that asset once). 
  • the assets shown to the user will be ordered according to:
    1. The priority of the Variation
    2. The priority of the asset established in the Variation 
• When a user does not belong to any segment, they will see assets associated with the "Anyone" Variation. 

 

• The order in the presentation of the variations on the Collection Page will be changed; the new created variations will be placed in the end of the list, so the "Anyone" variation won't be the last one until the user changes the order. The more higher the variation is placed on the list, the more priority it has (see LPS-101448).
• always be in the last place (the hypothesis that we are assuming is that the more generic variations are created prior to the more specific ones). Example: Collection with 3 Personalized Variations (plus Anyone). The temporal order of creation of the PVs is: PV1, PV2, PV3. The order of the PVs on the side of the page would be:
  • PV3
  • PV2
  • PV1
  • Anyone
• The priority of variations for users belonging to more than one segment will be the same featured on the list, that is: the highest placed variation will be prioritized over the next newer one, and so on.
  • When the setting Combine Assets from All Segments in Asset Publisher for Manual Collections is enabled (This setting was introduced in LPS-108368 and it's disabled by default. Its purpose is to allow a user to see the assets from all personalized variations it can belong to, instead of just the personalized variation with more priority. There's one setting for manual collections and another for dynamic collections. (You can find it in Control Panel > System Settings > Assets > Collections.), and only for the case of manual collections, we will sort first by variation priority and then by position (see https://issues.liferay.com/browse/PTR-2036 for details). This means that all assets included in the prioritized variation will be displayed in the first place, an then the assets included in the next variation, and so on. Assets won't be repeated, so in the case of an asset that is included in several variations, it will be displayed only once (in the most prioritized variation it is included).-- 

• "Anyone" variation won't be never shown to users belonging to at least one segment.
• We will add a help message informing about the prioritization: Create personalized variations of collections for different segments. For those users belonging to more than one segment, the variation displayed will be the one that is placed higher in the list. This message will show right below the PERSONALIZED VARIATIONS title, replacing the "No personalized variations yet" text when the first variation is created.

Acceptance Criteria

Note.- tested with Asset Publisher > Collections. Full test cases table should consider all these:

	Manual Collection	Dynamic Collection	Manual Collection + check enabled	Dynamic Collection + check enabled
Asset Publisher
Collection Display Fragment

 

• Given a user belonging to Segment 1
• When there's a variation of a manual or dynamic collection targeting segment 1, and it is prioritized above the Anyone variation
• Then the user belonging to that segment will see only the assets included in that variation

–

• Given a user belonging to Segment 1 and Segment 2
• When there's a variation of a manual or dynamic collection targeting segment 1 (variation 1), and another one targeting segment 2 (variation 2), and variation 1 is prioritized above variation 2
• Then the user will see only the assets included in variation 1

–

• Given a user belonging to Segment 1 and Segment 2, and the check Combine assets... enabled
• When there's a variation of a manual or dynamic collection targeting segment 1 (variation 1), and another one targeting segment 2 (variation 2), and variation 1 is prioritized above variation 2
• Then the user will see first the assets included in variation 1, and then the assets included in variation 2

–

• Given a user belonging to Segment 1 and Segment 2, and the check Combine assets... enabled
• When there's a variation of a manual or dynamic collection targeting segment 1 (variation 1), and another one targeting segment 2 (variation 2), and there's an asset included in the two variations
• Then the repeated asset will be displayed only in the prioritized variation 

 --

• Given the variation creation page 
• Then the help text is the following: Create personalized variations of collections for different segments. For those users belonging to more than one segment, the variation displayed will be the one that is placed higher in the list.

Acceptance Criteria

Requirements	Acceptance Criteria	Test Strategy	Covered by frontend test? (Yes/No)	Covered by backend test? (Yes/No)**
The new created variations will be placed in the end of the list, so the "Anyone" variation won't be the last one until the user changes the order. The more higher the variation is placed on the list, the more priority it has	Given a Segment 1 When the user creates a new variation Then the new variation created is displayed at the bottom of the list	Low	No	No
	Given a user belonging to Segment 1 When there's a variation of a manual collection targeting segment 1, and it is prioritized above the Anyone variation Then the user belonging to that segment will see only the assets included in that variation in Asset Publisher	High	No	No
	Given a user belonging to Segment 1 When there's a variation of a manual collection targeting segment 1, and it is prioritized above the Anyone variation Then the user belonging to that segment will see only the assets included in that variation in Collection Display Fragment	High	No	No
	Given a user belonging to Segment 1 When there's a variation of a dynamic collection targeting segment 1, and it is prioritized above the Anyone variation Then the user belonging to that segment will see only the assets included in that variation in Asset Publisher	High	No	No
	Given a user belonging to Segment 1 When there's a variation of a dynamic collection targeting segment 1, and it is prioritized above the Anyone variation Then the user belonging to that segment will see only the assets included in that variation in Collection Display Fragment	High	No	No
	Given a user belonging to Segment 1 When there's a variation of a manual collection targeting segment 1, and it is not prioritized above the Anyone variation Then the user belonging to that segment will see only the assets included in 'Anyone' in Asset Publisher	Medium	No	No
	Given a user belonging to Segment 1 When there's a variation of a manual collection targeting segment 1, and it is not prioritized above the Anyone variation Then the user belonging to that segment will see only the assets included in 'Anyone' in Collection Display Fragment	Medium	No	No
	Given a user belonging to Segment 1 When there's a variation of a dynamic collection targeting segment 1, and it is not prioritized above the Anyone variation Then the user belonging to that segment will see only the assets included in 'Anyone' in Asset Publisher	Medium	No	No
	Given a user belonging to Segment 1 When there's a variation of a dynamic collection targeting segment 1, and it is not prioritized above the Anyone variation Then the user belonging to that segment will see only the assets included in 'Anyone' in Collection Display Fragment	Medium	No	No
The priority of variations for users belonging to more than one segment will be the same featured on the list, that is: the highest placed variation will be prioritized over the next newer one, and so on.	Given a user belonging to Segment 1 and Segment 2 When there's a variation of a manual collection targeting segment 2, and it is prioritized above the variation targeting segment 1 And both are prioritized above the anyone variation Then the user will see only the assets included in the variation targeting segment 2 in Asset Publisher	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 When there's a variation of a manual collection targeting segment 2, and it is prioritized above the variation targeting segment 1 And both are prioritized above the anyone variation Then the user will see only the assets included in the variation targeting segment 2 in Collection Display Fragment	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 When there's a variation of a dynamic collection targeting segment 2, and it is prioritized above the variation targeting segment 1 And both are prioritized above the anyone variation Then the user will see only the assets included in the variation targeting segment 2 in Asset Publisher	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 When there's a variation of a dynamic collection targeting segment 2, and it is prioritized above the variation targeting segment 1 And both are prioritized above the anyone variation Then the user will see only the assets included in the variation targeting segment 2 in Collection Display Fragment	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 And the configuration to combine assets is enabled When there's a variation of a manual collection targeting segment 1 and segment 2, and both are prioritized above the anyone variation Then the user will see the assets included in both variations targeting segments in Asset Publisher	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 And the configuration to combine assets is enabled When there's a variation of a manual collection targeting segment 1 and segment 2, and both are prioritized above the anyone variation Then the user will see the assets included in both variations targeting segments in Collection Display Fragment	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 And the configuration to combine assets is enabled When there's a variation of a dynamic collection targeting segment 1 and segment 2, and both are prioritized above the anyone variation Then the user will see the assets included in both variations targeting segments in Asset Publisher	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 And the configuration to combine assets is enabled When there's a variation of a dynamic collection targeting segment 1 and segment 2, and both are prioritized above the anyone variation Then the user will see the assets included in both variations targeting segments in Collection Display Fragment	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 And the configuration to combine assets is enabled When there's a variation of a manual collection targeting segment 1 and segment 2, and both are prioritized above the anyone variation And there is an asset present in both variations Then the user will see the asset only once in Asset Publisher	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 And the configuration to combine assets is enabled When there's a variation of a manual collection targeting segment 1 and segment 2, and both are prioritized above the anyone variation And there is an asset present in both variations** Then the user will see the asset only once in Collection Display Fragment	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 And the configuration to combine assets is enabled When there's a variation of a dynamic collection targeting segment 1 and segment 2, and both are prioritized above the anyone variation And there is an asset present in both variations** Then the user will see the asset only once in Asset Publisher	Medium	No	No
	Given a user belonging to Segment 1 and Segment 2 And the configuration to combine assets is enabled When there's a variation of a dynamic collection targeting segment 1 and segment 2, and both are prioritized above the anyone variation And there is an asset present in both variations** Then the user will see the asset only once in Collection Display Fragment	Medium	No	No