User profile
From VYRE
A User profile, or simply Profile as it is also known, contains information on a user stored within Unify.
Contents |
Function
While there may be many user realms, with user information stored locally or remotely, each user also has a profile, with an id which is unique across all realms. This is used to store information which might not be available in some or all of the realms, but is required for all users of the system.
Usage
Basic profile properties exists in the system, and custom profile properties can be added through the realm. These properties can be edited through the my desktop module or through portlets such as the user create portlet or the user edit portlet.
Profile fields
A profile is made up of a number of fields. Some of these are read only and cannot be edited through Unify. Some of these are editable through the backend and through the user create and edit portlets.
Non editable Fields
The following is a list of fields stored in the user profile which are not editable by users. However, some will be updated automatically by Unify, for example lastLoginDate.
- userId
- realmId
- username (not editable but is created by the User)
- creationDate
- modificationDate (Cannot be set manually, but is updated every time the profile is updated)
- lastLoginDate
- lockDate
- deleted (not editable, but is set when a profile is deleted)
- deleteDate
- deletedBy
Editable fields
The following is a list of fields which are editable through Unify. Most can be edited by adding the appropriate filed to an user edit/create portlet. Most of the fields can be found under the general heading in the portlets.
- locale
- timezone
- active
- locked
- receiveEmail
- lease
- leaseExpiryDate
- leaseStartDate
- deactivationDate
Profile Properties
Each profile, as well as containing the above fields, also has a list of profile properties. There are a number of default properties but it is also possible to create your own profile properties.
Default properties
The default properties already contained in the system can be edited through the user edit and create portlets under the default attributes heading.
Custom properties
If the defaults are not enough or do not provide what you need, it is possible to create custom properties. These can added to user edit/create portlets. The fields can be found under the custom attributes headings. These can be created individually for each realm in the realm edit page.
Profile property definitions
In order to create custom properties, you will need to create a Profile property definition. They provide similar functionality for users as attribute definitions do for items. These can be created via the realm edit page (Users and groups -> User Realm -> {your_realm}]]). Here you will find a button called Profile property definitions. Clicking on this will give you a list of the profile property definitions that already exist in the realm. To create a new one, simply click on create. When creating a new one, you will be asked for a number of options:
- Localization key - the localisation that will be used when displaying this property (for example in user edit portlets)
- Name - the name of the property
- Description - the description of the property.
- Default Value - this can be left empty. If not left empty, this will be the default value of the property
- Type - the type of the value
- Presentation rule - the presentation reule that should be used when displaying the property in portlets
- required - whether or not the property is required.
My Preferences
This allows users to personlise unify. The following choices are available:
- Skin: choice of different skins (red,green and brown) ;
- Locale: list of locales
- Time Zone: list of timezones
- Use code syntax highlighting: checkbox that switches on/off syntax highlighting in the code template section
