Sun Java System Communications Express 6 2005Q4 Administration Guide

Setting Hosted Domains

The domain related configurable parameters are stored in the following files:

When Communications Express is deployed, these files are by default copied to uwc-deployed-path/WEB-INF/domain directory.

For a particular user\qs session, the domain related property files are searched in the following order:

ProcedureHosted Domains

Steps
  1. uwc-deployed-path/WEB-INF/domain/ user\qs domain/property-files

  2. uwc-deployed-path/WEB-INF/domain/ property-files

Creating Hosted Domain

This section describes the steps you need to perform to create hosted domains.

ProcedureTo specify the domain related properties for a particular domain:

Steps
  1. Create a directory with the domain name under uwc-deployed-path /WEB-INF/domain.

    For example: uwc-deployed-path/WEB-INF/domain/domain-name

  2. Copy the domain related configuration files under uwc-deployed-path /WEB-INF/domain directory to this directory. Refer to the section, Setting Hosted Domains for a list of domain related parameters.

  3. Customize the property files in the uwc-deployed-path /WEB-INF/domain/domain-name directory as explained in the sections below.

  4. To enable Access Manager login url to be constructed according to the domain specific URL of Communications Express, set the fully qualified virtual hostname, uwc.isvirtualhostname, to the virtual hostname of Access Manager.

    For example, when

    ce.virtualdomain.com.isvirtualhostname=is.virtualdomain.com

    and if you are accessing Communications Express from http://ce.virtualdomain.com/uwc

    then the Access Manager URL will appear as

    http://is.virtualdomain.com/amserver/UI/Login .

    If the fully qualified virtual hostname is not mapped to the to the virtual hostname of the Access Manager, Communications Express constructs the Access Manager login URL based on the static Access Manager login URL configured in uwcauth.identity.login.url.

    For example, if uwcauth.identity.login.url=http://siroe.com:85/amserver/UI/Login and you access Communications Express from a domain specific URL such as http://ce.varrius.com:80/uwc , Communications Express will construct the IS login URL as:

    http://siroe.varrius.com:85/amserver/UI/Login

    where the domain is, varrius.com.

    If the domain is ce.varrius.com, Communications Express will construct the Access Manager login URL as: http://siroe.ce.varrius.com:85/amserver/UI/Login .

  5. Make the following changes in the Access Manager configuration:

    1. Define FQDN mapping in AMconfig.properties. The default location of AMconfig.properties file is: /etc/opt/SUNWam/config/AMconfig.properties

      For example, if Access Manager is accessed from the virtual host as is.virtualdomain.com, the FQDN mapping will appear as:

      com.sun.identity.server.fqdnMap[is.virtualdomain.com]=is.virtualdomain.com

    2. Add virtualdomain.com in the additional cookie domain field in cookie domains, under service configuration -\> platform .

Configuring Parameters for Hosted Domain

The following sections describe the settings you can configure for a domain in Communications Express:

Configuring Parameters in uwcdomainconfig.properties file

The uwcdomainconfig.properties files maintains the default values of the calendar and address book related user preferences that can be configured on a per domain basis. These default user preference values are dynamically assigned to new users, when they access calendar and address book in Communications Express for the first time.

Table 6-1 lists the default user preferences in the application.

Table 6–1 Default User Preferences in uwcdomainconfig.properties File

Parameter 

Default Value 

Description 

uwc-user-attr-sunUCDefaultApplication 

 

Specifies the page to be displayed after you login. 

When Messenger Express is deployed, the Mail page by default appears as the login page. Otherwise, the Calendar page is displayed. If Calendar is not deployed, the user is taken to the Address Book page. 

uwc-user-attr-sunUCDefaultEmailHandler 

uc, desktop 

Specifies the default email client used to send email messages from the application. 

You can set the default email client to Messenger Express or to a browser mail client.

uwc-user-attr-sunUCDateFormat 

M/D/Y 

Specifies the order in which the date, month, and year should appear in a date. 

The available options are: 

M/D/Y, D/M/Y, Y/M/D 

uwc-user-attr-sunUCDateDelimiter 

Specifies the delimiter used in dates.

Delimiter is the character that separates the date, month, and year in the date. 

You can specify the delimiter as a comma(,), forward slash (/), or hyphen(-). 

uwc-user-attr-sunUCTimeZone 

America/Los_Angeles 

Specifies the time zone in which your calendar is created.

You can choose any valid time zone from the following areas: 

North and South America, Europe and Africa, Asia and Pacific Rim. 

Table 6–2 Default Calendar Preferences in uwcdomainconfig.properties File

Parameter 

Default Value 

Description 

uwc-user-attr-icsExtendedUserPrefs-ceDefaultView 

dayview 

Specifies the view your default calendar should display after you login. The available options are:

dayview, weekview, monthview, and yearview. 

uwc-user-attr-icsExtendedUserPrefs-ceShowCompletedTasks 

false 

Specifies whether the completed tasks will appear in the Tasks pane of the calendar. 

Change the default value to “true” if you want the completed tasks to appear in the Tasks pane of the calendar. 

uwc-user-attr-icsExtendedUserPrefs-ceDefaultCategory 

Business 

Specifies the default category in which the new events or tasks should be created.

The categories available are: 

Anniversary, Appointment, Birthday, Business, Breakfast, Class, Conference Call, Dinner, Holiday, Lunch, Meeting, Other, Personal, Seminar, Training, Travel, Vacation and Interview.

uwc-user-attr-icsExtendedUserPrefs-ceDayHead 

Specifies the day start time in hours. 

uwc-user-attr-icsExtendedUserPrefs-ceDayTail 

18 

Specifies the day end time in hours. 

uwc-user-attr-icsExtendedUserPrefs-ceInterval 

PT1H0M 

(One hour) 

Specifies the interval the day is split into. 

In the day and week view, the day is split into half an hour or one hour time period. 

You can change the default split value to PT0H30M(half hour) 

uwc-user-attr-icsFirstDay 

Specifies the day of the week to be considered as the first day of the week in the calendar. By default, Sunday(1) is considered to be first day of the week and Saturday(7) the last day of the week. 

uwc-user-icsExtendedUserPrefs-ceWeekEndDays 

1,7 

Specifies the days of the week in the calendar views to be considered as weekend days. 

By default, Sunday(1) is the first day of the week and Saturday(7) the last day of the week. 

Comma separated list of numbers represents the days of the week to be considered as week end days. 

uwc-user-attr-icsExtendedUserPrefs-ceIncludeWeekendInViews 

false 

Enables or disables the display of weekend days in the Week and Month views of your calendar. 

Set the default value to “true” if the weekend days should be displayed in the Week and Month views of the calendar. 

uwc-user-attr-icsExtendedUserPrefs-ceSingleCalendarTZISD 

true 

Specifies whether the calendar should be displayed in the calendar’s time zone. 

Change the default value to “false” if you do not want to view calendars in the calendar’s time zone. In this case, all calendars will be displayed in the time-zone specified in Global Options tab. 

uwc-usr-attr-icsExtendedUserPrefs-ceDefaultAlarmStart 

PT0H30M 

Specifies the default number of hours and minutes before an event or task a reminder should be sent. 

uwc-user-attr-icsExtendedUserPrefs-ceNotifyEnable 

false 

Specifies whether to send email messages (containing ical attachments) to internal invitees when new events are created. 

Valid values are: false, true. 

Table 6–3 Default Address Book Preferences in uwcdomain.properties File

Parameter 

Default Value 

Description 

uwc-user-sunAbExtendedUserPrefs-abName 

Personal Address Book 

Specifies the name of the default address book. 

uwc-user-attr-sunAbExtendedUserPrefs-abDescription 

This is the personal address book 

Specifies a short description for the default address book. 

uwc-user-attr-sunAbExtendedUserPrefs-abEntriesPerPage 

25 

Specifies the maximum number of address book entries to be displayed on a page. The available options are: 25, 50, 75. 

uwc-user-attr-sunAbExtendedUserPrefs-abSearchDisplayColumn1 

displayname 

Specifies the value to be displayed in the first column. By default, the first column displays name of contacts or group. 

uwc-user-attr-sunAbExtendedUserPrefs-abSerchDisplayColumn2 

primaryemail 

Specifies the value to be displayed in the second column of your address book. 

You can set the display column name to: 

displayname, company, title, primaryphone, workphone, homephone, faxphone, pagerphone, primaryemail, email2, email3, homeaddress, workaddress, weburl1, weburl2, calendarurl, freebusyurl, birthday, anniversary ,ou, edit, viewcalendar.

uwc-user-attr-sunAbExtendedUserPrefs-abSearchDisplayColumn3 

 

Specifies the value to be displayed in the third column of your address book. 

You can set the display column name to: 

displayname, company, title, primaryphone, workphone, homephone, faxphone, pagerphone, primaryemail, email2, email3, homeaddress, workaddress, weburl1, weburl2, calendarurl, freebusyurl, birthday, anniversary ,ou, edit, viewcalendar.

uwc-user-attr-sunAbExtendedUserPrefs-abSearchDisplayColumn4 

edit 

Specifies the value to be displayed in the fourth column of your address book. 

You can set the display column name to: 

displayname, company, title, primaryphone, workphone, homephone, faxphone, pagerphone, primaryemail, email2, email3, homeaddress, workaddress, weburl1, weburl2, calendarurl, freebusyurl, birthday, anniversary ,ou, edit, viewcalendar.

Configuring the personalstore.properties file

Modify the parameters in personalstore.properties file to configure address book store, corporate directory and any remote directories.

Table 6-4 lists the settings stored in personalstore.properties file.

Table 6–4 Configuration Settings Stored in personalstore.properties File

Parameters 

Default Value 

Description 

db.defaultpsrootpattern 

ldap://piPStoreOwner=%U,o=%D,o=PiServerDb 

Specifies the pattern used to dynamically construct the psRoot value for a user. The psroot identifies the location where a user entry resides.

%U = uid of the user ("jsmith") 

%D = domain of the user ("siroe.com") 

%O = most significant part of the domain ("siroe") 

db.xxx.class 

com.iplanet.iabs.ldap.plug.iLDAP 

Specifies the name of the java class implementing the plug-in. For example, LDAP plug-in. 

db.xxx.urlmatch 

 

Specifies the URL in the format: 

ldap://host:port/DN 

Based on this parameter the xxx instance is identified. 

This value should correspond to the “bookremoteurl” attribute stored in defaultps.xml file.

db.xxx.configpath 

 

Specifies the path to the configuration directory containing the LDAP information for this instance. 

If the path is relative, it is relative to the location of this file. 

db.xxx.wildcardsearch 

 

Specifies the minimum number of characters to be provided in a wild card search. 

db.xxx.randompaging 

false 

Specifies whether the plug-in supports random access and whether each page must be accessed from the first page. 

If false, the search process will continue to search until it gets the right page. 

db.xxx.corporatedir 

false 

For a corporate directory this value should be true. 

db.useUserPsRoot 

false 

Set the value to true to use the user’s psRoot value. If set to false, the defaultserver values are used. 

Configuring defaultps.xml file

The defaultps.xml file contains the default definitions for personal and corporate address books that are created in the LDAP store when a user logs in for the first time.

Each book node contains a book definition that is created for users in the domain under which the defaultps.xml file resides.

Following are examples of the XML sections in defaultps.xml that contain the definitions of Personal Address Book and a Corporate Address Book.

Personal Address Book XML


Example 6–1 XML section containing Personal Address Book Definitions


<book booktype="abook"\>
<bookoc\>piLocalBook</bookoc\>
<entry entryID="pab"\>
<displayname\>_Personal Address Book</displayname\>
<description\>_This is your Personal Address Book</description\>
</entry\>
</books\>

Corporate Directory XML


Example 6–2 XML section containing Corporate Address Book Definitions


<book booktype="abook"
bookremoteurl="ldap://corpdirectory"\>
<bookoc\>piRemoteBook</bookoc\>
<entry entryID="idirectory"\>
<displayname\>_Corporate Directory</displayname\>
<description\>_This is Corporate Directory</description\>
</entry\>
</book\>

ProcedureCorporate Address Book

For corporate and remote address books a corresponding xxx instance should exist in the personalstore.properties file. The value of db.xxx.urlmatch in personalstore.properties file should be assigned the value of bookremoteurl attribute present in defaultps.xml file.

To add a new remote address book, you need to add the following items:

Steps
  1. Add a new book node in defaultps.xml file

  2. Add a new xxx instance in personalstore.properties file.

  3. Create a directory under WEB-INF/config to store the db_config.properties and xlate files.


    Note –

    The xlate files contains the field mappings between an LDAP schema and address book XML schema for a contact or group.


Customizing the Global GUI

Theme file contain the logical names of the icons appearing in Communications Express and their default location. You can change the location of the images by changing the path specified in this file. The default theme.properties file is located under uwc-deployed-path/WEB-INF/skin.

Configuring Languages in uwcdomainconfig.properties File

The uwcdomainconfig.properties files contains the list of supported languages for a domain. Each language in the list is separated by a semi colon. You can define the list of languages Communications Express will support for a domain.

For example, if you are planning to support en (English), de (German), fr (French), and ja (Japanese) languages in a domain called siroe.com, then set supportedLanguages in uwcdomainconfig.properties file for that domain to supportedLanguages=en;fr;de;ja.

The uwcdomainconfig.properties file siroe.com should be located at:

WEB-INF/domain/siroe.com/uwcdomainconfig.properties

You will also have to define the localizable strings in the corresponding i18n.properties files. For example,

uwc-common-options-preferredLanguage-en=English

uwc-common-options-preferredLanguage-de=German

uwc-common-options-preferredLanguage-fr=French

uwc-common-options-preferredLanguage-ja=Japanese

The i18n.properties file for siroe.com will be located at:

WEB-INF/domain/siroe.com/locale/ i18n.properties

In the absence of a preferredLanguage attribute in the User’s LDAP entry, the domain preferredLanguage attribute, the browser provided header values and the availability of i18.properties file determines the language used in the users session.