Sun Java System Communications Express 6.3 Administration Guide

Chapter 6 Configuring Hosted Domains

Communications Express supports the hosted domain structure for an organization. This chapter describes the changes to be made to Communications Express to enable hosted domains.

Before you Begin

In order for Communications Express to support hosted domains, you should first enable this support in the following dependent components.

Mail Server
Calendar Server
Address Book Server

This section describes the changes to be made in the dependent components ofCommunications Express to enable hosted domain (also known as virtual domains) support.

Enabling Hosted Domain Support in Mail

To provision a domain and to learn about creating a hosted domain entry in the organizational tree for Sun Java System LDAP Schema v.1, refer to Chapter 2, Provisioning Domains, in the iPlanet Messaging Server 5.2 Provisioning Guide.

For information on how to customize the mail client interface for each domain, refer to Chapter 8, Customizing Domains, in Sun Java System Communications Express 6.3 Customization Guide in Sun Java System Communications Express 6.3 Customization Guide.

Enabling Hosted Domain Support in Calendar

To enable hosted domain configuration in Calendar Server, you must configure Calendar Server for hosted domains. For Information on how to configure Calendar Server for hosted domains, see Chapter 10, Setting Up a Multiple Domain Calendar Server 6.3 Environment, in Sun Java System Calendar Server 6.3 Administration Guide.

Enabling Hosted Domain Configuration in Address Book

To enable hosted domain configuration in Address Book, set the virtualdomain.mode parameter to y in the uwc-deployed-path /WEB_INF/config/uwcauth.properties file

Modify the following files to enable hosted domains.

uwc-deployed-path /WEB-INF/domain/personalstore.properties file. For more information on the changes required, see Configuration Parameters in the personalstore.properties File.
uwc-deployed-path /WEB-INF/domain/defaultps/defaultps.xml file. For more information on the changes required, see Creating Additional Remote Address Books.

Creating and Configuring a Hosted Domain

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

To Configure Communications Express for Hosted Domain Support

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

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

Copy the following domain related configuration files under uwc-deployed-path /WEB-INF/domain directory to this directory.

The domain related configurable parameters are stored in the following files:
- uwcdomainconfig.properties
- personalstore.properties
- defaultps/defaultps.xml
- lang/ il8n.properties. For example, en/i18n.properties

Customize the property files in the uwc-deployed-path /WEB-INF/domain/domain-name directory .

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

For a particular user's session, the domain related property files are searched in the following order:
- uwc-deployed-path/WEB-INF/domain/ user's domain/property-files
- uwc-deployed-path/WEB-INF/domain/ property-files
Refer to Configuration Parameters for Hosted Domain for setting domain specific properties for your set up.

Configuration Parameters for Hosted Domain

Configuration Parameters in the `uwcdomainconfig.properties` File

The uwcdomainconfig.properties file maintains the default values of the calendar and address book-related user preferences that can be configured according to each domain. 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.

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


Parameter	Default Value	Description
`uwc-user-attr-sunUCDefaultApplication`		Specifies the page to be displayed after you log in. 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	Specifies the default email client that is 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 lists the user preferences related to Calendar application.

Table 6–2 Default Calendar Preferences in the 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` `yearview`
`uwc-user-attr-icsExtendedUserPrefs-ceShowCompletedTasks`	`false`	Specifies whether the completed tasks will appear in the Tasks pane of the calendar. Change the 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` `Interview`
`uwc-user-attr-icsExtendedUserPrefs-ceDayHead`	`9`	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`	`1`	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) is considered 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 weekend 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 are 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 to internal invitees when new events are created. By default, this value is set to "1" that is `true` . Valid values are: `false`, `true`.
`uwc-user-attr-hideCalId`	`false`	Specifies whether to allow domain users of Communications Express the option of not seeing the `calid` in their calendars. If `calid` needs to be hidden, this value should be set to `true`.

Table 6–3 lists the Configurable Address Book default user preferences.

Table 6–3 Default Address Book Preferences in the uwcdomainconfig.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`, and `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` `editviewcalendar`
`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`

Configuration Parameters in the `personalstore.properties` File

Modify the parameters in the 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. `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.ldapplut.class`	`com.iplanet.iabs.ldap.plug.iLDAP`	Specifies the name of the Java class implementing the plug-in. For example, LDAP plug-in.
`db.ldapplug.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.ldapplug.configpath`		Specifies the path to the configuration directory containing the LDAP information for a particular instance. This path is relative to the location of this file.
`db.ldapplug.wildcardsearch`	`0`	Specifies the minimum number of characters to be provided in a wild card search.
`db.ldpaplug.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 continues until it gets the right page.
`db.ldapplug.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.

Customizing the Global GUI

The default themes.properties file is located under uwc-deployed-path/WEB-INF/skin.The theme file contains 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.

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.