Session Property Vocabularies

Available Liferay DXP/Portal 7.3+

With a Session Property Vocabulary, you can create session-based Segment properties using predefined values. This option is useful when you don’t want the Segment editor to enter the properties’ values manually while creating a new Segment; instead, you want the user to select them from a list of predefined values. Session Property Vocabularies facilitate the task of defining Segments and eliminate manual entry errors.

For example, your Marketing team may use a device’s brand information to target different content to your website visitors, like the promotion of a new app for Apple devices. To facilitate the process of the Marketing team, you can create a Session Property Vocabulary that includes the different device brands and link this Vocabulary to the user Segment. This way, when the Marketing team makes a Segment using the “Device Brand” session property, they don’t need to type the different Device Brand options. The list of possible options is now predefined for them.

You work with Session Property Vocabularies in three steps:

1. Configure the Vocabulary for the session-based Segment.

2. Define the Session Property Vocabulary.

3. Create the session-based Segment.

Configuring the Vocabulary for the Session-Based Segment

The categories you define on this Vocabulary (1) are the ones you can choose when you create a Segment using the session properties (2).

You can create a new global Vocabulary or use an existing one. To create a new Vocabulary or update the Categories on an existing one, see Defining Categories and Vocabularies for Content. You can use vocabularies with Public or Internal Visibility. Session Property Vocabularies only work with global vocabularies.

note

You can only create and edit global vocabularies in the global Site.

Defining the Session Property Vocabulary

After configuring the Vocabulary for the session-based Segment, you must link the Vocabulary to one of the available session properties in a new Session Property Vocabulary.

1. Click the global Menu and click the Control Panel tab.

2. Under the Configuration section, click System Settings.

3. In the Content and Data section, click Segments.

4. Click Session Property Vocabularies.

5. Click Add to create a new Session Property Vocabulary.

6. Select the property in the Selection Property drop-down menu.

   

   note

   You cannot select properties that belong to another Session Property Vocabulary. These properties are grayed-out and unavailable.

7. Select the Vocabulary in the Vocabulary Name drop-down menu.

8. Click Save.

Creating the Session-Based Segment

After configuring the Vocabulary and defining the Session Property Vocabulary, you can create the Segment. For information on creating segments, see Creating and Managing User Segments.

When you define the Segment’s conditions and you use one of the session properties linked to the global Vocabulary, the conditions for the session property are now predefined and you can select them from a drop-down menu. This drop-down menu corresponds the list of categories for the Vocabulary you define in the Session Property Vocabulary.

important

When you delete one of the categories or the Vocabulary that is linked to a User Segment in a Session Property Vocabulary, the Segment keeps working based on your definiton. Liferay alerts you of this situation in the Segment editor.

Related Information

• Defining Categories and Vocabularies for Content
• Creating and Managing User Segments
• Segments Editor UI Reference

Not finding what you're looking for?

Pardon our dust as we revamp and transition our product documentation to this site. If something seems missing, please check Liferay Help Center documentation for Liferay DXP 7.2 and previous versions.

Try Liferay's Help Center