Creating and Managing Property Sets

 

This following topics are included:

Overview of Property Sets

Property Value Retrieval via ConfigurableEntity

Using the Property Set Management Tool

Creating Property Sets

Creating Properties within a Property Set

Editing Property Sets

Editing Properties within a Property Set

Deleting Property Sets

Deleting Properties

Using the Property Set Management tool, you can create property sets, the schemas for personalization attributes schema and define the properties that make up these property sets.

 

---

Overview of Property Sets

In the most general sense, a property can be considered a name/value pair. Property sets serve as namespaces for properties so that properties can be conveniently grouped and so that multiple properties with the same name can be defined.

For instance, the web site developers might want users to be able to specify different background colors for each of their portals by requiring the property "backgroundColor" for a user. By creating "portalA" and "portalB" property sets, the property "backgroundColor" can exist for both portal A and portal B. While the two "backgroundColor" properties have the same name, they could have the same or different definitions. Figure 3-1 shows two property sets with redundant property names, corresponding to unique definitions.

Figure 3-1 Property Sets Serving as Namespaces.

A property definition includes the following information:

• Property Value Type: The data type of the property value, e.g., Text, Integer, Float, Date/Time. A property called "age" might be an Integer type, while "lastName" would most likely be Text.

• Plurality: Whether the property can contain a single value, or multiple values. A property called "firstName" might be a single-valued property, while "petPeeves" would most likely be multi-valued.

• Restriction: Whether the allowable values for a property are restricted. A property called "favoriteDayOfTheWeek" would only have seven possible values, while "email" would most likely be unrestricted.

• Default Property Value: A default value provided by the property set corresponding to the property. A property called "favoriteDay" might have a default value of "Saturday."

For Personalization Server purposes, property sets are applied to four major areas.

1. User and Group Profiles

The "User/Group" property set type is used for defining the property sets and properties that apply to user and group profiles. For example, a property set of this type might be created called "portalA". Subsequent property retrieval for a particular user or group can then be scoped with this property set name to retrieve the user's background color for the portal. Please see the "Creating and Managing Users" for an in-depth discussion of how property retrieval works for users and groups.

1. HTTP Sessions

The "Session" property set type is used for defining the property sets and properties that apply to HTTP sessions. Like the "User/Group" property set type, a "Session" property set type might be called "portalA". Properties available through this property set can then be accessed via the Personalization Advisor.

1. HTTP Requests

The "Request" property set type is used for defining the property sets and properties that apply to HTTP requests. Again, like the "User/Group" property set type, a "Request" property set type might be called "portalA." Properties available through this property set can then be accessed via the Personalization Advisor.

1. Content Management

The "Content Management" property set type is used for defining the configuration and run-time use of the Content Management system. "Content Management" property sets cannot be created or manipulated with the Personalization Server administration tools. Please see "Creating and Managing Content" for more complete information on this subject.

Creating a property set is a simple task via the Property Set Management tools. A name for the set must be provided as well as a statement that describes the purpose of the property set. Properties can be copied from an existing property set if a preexisting property set defines similar properties. Expanding the previous example, if portal A's properties have been defined and portal B is going to have the same (or similar) properties, then time is saved by copying the properties from portal A's property set when creating portal B's property set. Finally, the type of property set ("User/Group", "Session", or "Request") must be chosen.

When defining a property, specify the following:

• Property name

• Description

• Type

• Selection option

• Creation category

Name is the name of the property, such as "backgroundColor". Description is a textual description of the property, perhaps describing the purpose of the property. Type is the data type of the property value. Date types supported by the administration tools are Text, Integer (equivalent to Long in Java), Floating-Point number (equivalent to Double in Java), Boolean, and Date/Time (equivalent to java.sql.Timestamp). Selection option determines whether the property is single-valued or multi-valued. Creation category determines whether the possible values are restricted. Restricted property values are restricted to values listed in the property definition. Unrestricted property values have no such limitation.

Property Definition Attribute	Attribute Value
Name	Text (100 character length maximum)
Description	Text (255 character length maximum)
Type	Text, Integer (equivalent to Long in Java), Floating-Point Number (equivalent to Double in Java), Boolean, or Date/Time
Selection Option	Single-Valued or Multi-Valued
Creation Category	Restricted or Unrestricted
Default Value	Up to you - can be null

Once created, "User/Group" property values can be edited for a particular user or group via the User Management user and group tools. For "Session" and "Request" properties, the only editable values are the default values set in the property definitions - runtime values are determined by values in the HTTP session or HTTP request, respectively.

 

---

Property Value Retrieval via ConfigurableEntity

Property Sets created with the administration tools are stored as com.beasys.commerce.foundation.property.Schema components. The component that acts as an "owner" of properties associated with Property Sets is the com.beasys.commerce.axiom.contact.ConfigurableEntity. During inspection of the javadoc for Schema and ConfigurableEntity, the reader may see the words "schema" and "scope" used interchangeably with "Property Set." Figure 3-2 shows a simplified representation of property value retrieval through a ConfigurableEntity. For the ConfigurableEntity, the value of backgroundColor for portalB has been overridden. The value of backgroundColor for portalA has not. Therefore, when backgroundColor is requested for the portalB property set, the overridden value, red, will be returned. When backgroundColor is requested for the portalA property set, the property set default value, white, will be returned.

Figure 3-2 backgroundColor Property Retrieval

Figure 3-3 shows another simple example of backgroundColor property retrieval to demonstrate the notion of an explicit successor. A second ConfigurableEntity can be specified in the ConfigurableEntity getProperty() API that acts as a "backup" place to look for a particular property value. This second ConfigurableEntity is considered an explicit property successor. In this example, a particular group is used as an explicit successor, and the value for portalA's background color, green, is "inherited" from this successor.

Figure 3-3 Explicit Successor, `backgroundColor' Property Retrieval.

Figure 3-4 provides an example of an implicit successor. An implicit successor is a successor tied to a particular Property Set. In this case, the user does not have a value for portalA.backgroundColor, and no explicit successor is provided in the getProperty() call. However, the group has already been associated with the user as its successor for the portalA Property Set. Again, the user "inherits" the property value, green, from the group.

Figure 3-4 Property Inheritance through Property Set-Related Successor.

There also exists the notion of a default successor, which can be searched after an explicit successor and a Property Set-related successor have failed to return a value for the property. Figure 3-5 shows such a case. In this example, the Property Set-related successor cannot produce the necessary property value for backgroundColor in portalA, so the value must be retrieved from the default successor.

Figure 3-5 Figure 5. Property Inheritance through a default Successor.

Keep in mind that these examples have been considerably simplified for brevity and to easily explain relevant concepts. More details of ConfigurableEntity property inheritance are available in the topic Users and Groups.

 

---

Using the Property Set Management Tool

The Property Set Management tools allow you to create and manage sets of typed properties. Property Sets may be defined to describe user and group, session, request, and content properties.

Creating Property Sets

To create a property set:

1. On the Administration Tools Home Page, click the Property Set Management icon. The Property Set Management home page appears.

2. Click create in the Property Sets banner. The Create Property Set page appears.

   To enter a new property set:

   1. Enter the name of the new property set in the Name field.

   2. Enter a description of the new property set in the Description field.

   3. Leave the Copy Properties From default as Don't copy properties.

      To copy properties from an existing property set into the new one:

   4. Enter the name of the new property set in the Name field.

   5. Enter a description of the new property set in the Description field.

   6. Select the appropriate property set containing the properties you want copied from the Copy Properties From drop-down list box.

3. Click create to create the property set or click back to return to the Property Set Management Home Page without saving the property set. The Property Set Management home page appears after the create operation completes.

Creating Properties within a Property Set

To create properties within a property set:

1. On the Administration Tools Home Page, click the Property Set Management icon. The Property Set Management Home Page appears.

2. From the Property Set list, select the appropriate title link for the property set you wish to add a property to. The Property Set view page appears.

3. Click create on the Properties bar. The Create Properties page appears.

   

   1. Enter the property name in the Property Name field.

   2. Enter a description of the new property in the Description field.

   3. Select the type from the Type drop-down list box.

   4. Select option (single, multiple) from the Selection Option drop-down list box.

      Note: The single option refers to those properties having only one option (e.g., Property: Color, Attribute: red). The multiple option refers to those properties having multiple options (e.g., Property: Colors, Attributes: red, green, blue, etc.).

   5. Select the creation of category (Restricted, Unrestricted) from the Creation Category drop-down box.

      Note: Restricted categories refer to values that are selected via a list, radio buttons, check boxes, etc. Unrestricted categories refer to instances in which users populate a form field.

4. Click create.

5. Click back to return to the Property Set view.

To set up the property default value:

Note: Different steps are required for setting up default values, given your option/category selection.

For single/restricted:

1. From Property Set view, click edit on the appropriate Property Set Description bar.

2. Click edit on the Properties Values bar.

3. Enter a new value to the property in the New Value field.

4. Click create. The new value appears in the Values matrix at the bottom of the page.

5. Indicate the default value(s) by selecting the appropriate check box(es).

6. Click save.

For single/unrestricted:

1. From Property Set view, click edit on the appropriate Property Set Description bar.

2. Click edit on the Properties Values bar.

3. Enter a new value to the property in the New Value field.

4. Click save.

For multiple/restricted:

1. From Property Set view, click edit on the appropriate Property Set Description bar.

2. Click edit on the Properties Values bar.

3. Enter a new value to the property in the New Value field.

4. Click create. The new value appears in the Values matrix at the bottom of the page.

5. Indicate the default value by selecting the appropriate radio button.

6. Click save.

For multiple-unrestricted:

1. From Property Set view, click edit on the appropriate Property Set Description bar.

2. Click edit on the Properties Values bar.

3. Enter a new value to the property in the New Value field.

4. Click save.

Editing Property Sets

To edit a property set:

1. On the Administration Tools Home Page, click the Property Set Management icon. The Property Set Management home page appears.

2. Click the appropriate title link from the Property Sets list. The Property Set view page appears.

   To edit the Property Set Description:

   1. Click edit on the Property Set Description bar. The Edit Property Set page appears.

      

   2. Enter the new description in the Description field.

   3. Click save to save changes. The general Property Set view appears with the new information. Alternately, click back to return to Property Set view page without saving your changes.

Editing Properties within a Property Set

To edit properties within a property set:

1. On the Administration Tools Home Page, click the Property Set Management icon. The Property Set Management home page appears.

2. Click the appropriate title link from the Property Sets list. The Property Set view page appears.

3. Click edit on the appropriate property bar. The specific Property view page appears, containing information specific to the property you wish to edit.

4. Click edit on the appropriate description or value bar. The Edit Property page appears.

5. Enter changes in the field(s) provided.

6. Click save. The specific Property view returns. Alternatively, click back. The specific Property view appears and your changes are not saved.

Deleting Property Sets

To delete a property set:

1. On the Administration Tools Home Page, click the Property Set Management icon. The Property Set Management home page appears.

2. Click the X to the right of the appropriate title link from the property set list.

3. Click OK to confirm the deletion.

Deleting Properties

To delete properties:

1. On the Administration Tools Home Page, click the Property Set Management icon. The Property Set Management home page appears.

2. Select the appropriate title link from the Property Sets list. The general Property Set view appears.

3. Click Delete on the Properties bar. The Delete Properties page appears.

   

4. Select a property from the Property Name list.

5. Click delete.

6. Click OK to confirm the deletion. The specific Property view returns. Alternatively, click back. The Property view appears and the property is not deleted.