Configuring the Profile Tools Component

The ProfileTools component includes a reference to the current profile repository through the profileRepository property. If you change this repository, you should also change this reference. This service provides methods that deal with the session-scoped Profile object and also contains lower-level, repository-specific helper methods. The ProfileTools class defines methods for locating users by login or user ID, creating users, and updating properties of profiles. If you change or remove user profile properties, you should make sure that the other components that refer to these properties are correctly referenced in the ProfileTools component. For more information, see User Profiling Tools in the Working with User Profiles chapter of this manual.

Personalization Module

Even if a property listed here is not required by the Personalization module, it may be required by another ATG server or demo application. Removing or renaming any of these properties from the profile repository definition may break other ATG features.

Property

Description

securityStatus

Used, if present, to set how users have authenticated themselves.

This property name is registered in the securityStatusPropertyName property of the /atg/userprofiling/PropertyManager component.

login

Required for authentication. You should avoid changing the name of this property since it is required by many other ATG services.

This property name is registered in the loginPropertyName property of the /atg/userprofiling/PropertyManager component.

password

Required for password authentication. You should avoid changing the name of this property since it is required by many other ATG services.

This property name is registered in the passwordPropertyName property of the/atg/userprofiling/PropertyManager component.

userType

Used for having sub-types of the base user item-descriptor.

locale

The Quincy Funds demo uses this property to allow customers to select their preferred locale. Not required, but used if present by the RequestLocale object in the internationalization features implemented by those demo applications. See the Internationalizing a Dynamo Web Site chapter in the Platform Programming Guide for more information.

This property name is registered in the localePropertyName property of the/atg/userprofiling/PropertyManager component. If you use a property with a name other than locale to represent a user’s locale, you must also change the value of the localePropertyName property of the/atg/userprofiling/PropertyManager component.

lastActivity

Set to the time when the person last logged in. This property is set in the /DSS/TrackActivity scenario that ships with the Scenarios module.

This property name is registered in the lastActivityPropertyName of the /atg/userprofiling/ProfileFindForm component.

registrationDate

Set to the time when the person registered. This property is set in the /DSS/TrackActivity scenario that ships with the Scenarios module.

email

The person’s e-mail address. Used by the targeted e-mail facility.

This property name is registered in the emailAddressPropertyName property of the/atg/userprofiling/PropertyManager component. If you use a property with a name other than email to represent a user’s e-mail address, you must also change the value of the emailAddressPropertyName property of the/atg/userprofiling/PropertyManager component.

emailStatus

Boolean flag that indicates whether the e-mail address is valid.

This property name is registered in the emailStatusPropertyName property of the/atg/userprofiling/PropertyManager component. If you use a property with a name other than emailStatus to represent whether a user’s e-mail address is valid, you must also change the value of the emailStatusPropertyName property of the/atg/userprofiling/PropertyManager component.

receiveEmail

Boolean flag to indicate if a user wants to receive e-mail. This property is used in scenarios to filter which users should receive targeted e-mail messages.

This property name is registered in the receiveEmailPropertyName property of the/atg/userprofiling/PropertyManager component. If you use a property with a name other than receiveEmailto represent whether a user should receive e-mail, you must also change the value of the receiveEmailPropertyName property of the/atg/userprofiling/PropertyManager component.

Scenarios Module

Property

Description

scenarioInstances

Points to a set of scenario instances currently in effect for the profile.

This property name is registered in the scenarioInstancesPropertyName of the /atg/userprofiling/PropertyManager component.

Copyright © 1997, 2014 Oracle and/or its affiliates. All rights reserved. Legal Notices