Chapter 8 Customizing Domains

Communications Express allows you to customize Mail, Calendar, and Address Book on a specific domain.

This chapter has the following contents:

• Default User Preferences

• Themes for a Specific Domain and Locale

• Mail Customization for a Specific Domain

• Address Book Customization for a Specific Domain and a Locale

Default User Preferences

The default user preferences that is to be used for a first-time user can be configured on a per-domain basis. The default user preferences can be configured in the uwcdomainconfig.properties file.

To Customize the Default User Preferences for a Domain

To configure default user preferences for a specific domain, for example, siroe.com, you need to do the following:

1. Create a directory with the name same as the domain name in <domain-dir> directory.

   For example, create <domain-dir>/siroe.com directory.

2. Create a directory with the locale name inside the domain directory.

   For example, if you want to have English locale for sireo.com, you must create a folder en in the domain directory. The directory structure would look as follows:

   /<domain-dir>/siroe.com/en

3. Copy uwcdomainconfig.properties file from <domain-dir> directory to the newly created directory above.

4. Make the required changes to uwcdomainconfig.properties file in<domain-dir>/siroe.com directory.

   You can configure the default user preferences for global, calendar and address book.

5. Restart the web server to apply changes

Themes for a Specific Domain and Locale

You can configure themes on a per-domain basis.

---

Note –

Currently Communications Express does not support customization of themes on a per-user basis

---

To Customize a Theme for a Specific Domain

To configure a theme for a specific domain, for example, siroe.com and a locale ja and fr, you need to do the following.

1. Create a directory with the name same as the domain name in <domain-dir> directory. For example, create <domain-dir>/siroe.com directory

2. Copy uwcdomainconfig.properties file from <domain-dir> to the <domain-dir>/siroe.com directory.

3. Modify the parameter uwc-user-attr-SunUCTheme to the required theme name in uwcdomainconfig.properties file in <domain-dir>/siroe.com directory.

   For example, to configure a theme “christmas“add the parameter uwc-user-attr-SunUCTheme-<locale-name>=christmas, where <locale-name> is the name of the locale for which you want the theme. For example: uwc-user-attr-SunUCTheme-en=christmas would correspond to the English locale. To configure a theme called “christmasJA” for Japanese locale, set uwc-user-attr-SunUCTheme-ja=christmasJA. To configure a theme called “christmasFR” for french locale, set uwc-user-attr-SunUCTheme-fr=christmasFR. The parameter “uwc-user-attr-SunUCTheme” is used for default locale. It is important that though the theme name could be anything, the property name should end with corresponding locale as mentioned in the example.

4. Create the directories <skin-dir>/christmasJA, <skin-dir>/christmasFR and <skin-dir>/christmas.

5. Copy themes.properties from <skin-dir>/ to <skin-dir>/christmasJA, <skin-dir>/christmasFR and <skin-dir>/christmas.

6. Edit the corresponding themes.properties file to point to the customized style sheets and images.

7. Restart the web container on which Communications Express is deployed to apply changes.

Mail Customization for a Specific Domain

This section describes how to customize the mail interface for each domain.

You can perform the following tasks to customize the client interface:

• Create a directory for mail with the domain name under <uwc-deployed-dir>/webmail/ directory.

• Copy the files from the default directory in the same hierarchy and customize them.

  For example, assume that you have a domain called siroe.com. To change the icon for the domain siroe.com, add a new icon in the imx directory of siroe.com and change the reference to it in the main.js file. Table 8–1 shows the directory structure for the domain siroe.com

Table 8–1 Directory Structure for the Domain siroe.com.

Directory	Description
webmail/...	// default interface
webmail/imx/...	// default image
webmail/en/...	// default language
webmail/siroe.com/main.js	// refers to the domain specific file
webmail/siroe.com/imx/bottle.gif	// refers to the customized images

• After login, the server refers the user agent to pick themail.html file that is located in the domain/lang directory. The mail.html file contains the relative references to the rest of the interface. The client requests all the files in the directory to make the interface. If these files exist in the domain/lang directory they are displayed, otherwise the default setup files from <uwc-deployed-dir>webmail/en/ are displayed.

  If you have many domains and only a few distinct ”brands’ then you can use links to make the server point to the correct brand

Table 8–2 Linking Multiple Domains to Few Distinct Brands

Directory	Description
html/...	// default interface
html/sesta.com/...	// customized interface for brand 1
html/varrius.com -> sesta.com	// default interface

Domain Customization Based on URL

The server listens to all IP addresses and presents a customized interface before the authentication occurs. The server does this by looking at the URL and by determining if it contains a known domain and presents the per domain Login screen for the domain.

For example, for the per domain Login screen: http://webmail.sesta.com/, the server presents the page from the location: <uwc-deployed-dir>/webmail/<domain-name>/en/default.html.

In this case a user does not have to suffix @domain to the user name to login.

For more information on Customizing the Mail Component, Sun Java System Messenger Express Customization Guide.

Address Book Customization for a Specific Domain and a Locale

In address book, all user interface related source files (XML/XSL) are located under <uwc-deployed-path>/WEB-INF/ui/html/abs directory by default. To customize the user interface for a domain, follow these steps.

To Customize Address Book for a Specific Domain and Locale

1. Create a directory with a domain name, (For example siroe.com) under <uwc-deployed-path>/WEB-INF/ui/html.

2. Copy all files from <uwc-deployed-path>/WEB-INF/ui/html/abs to<uwc-deployed-path>/WEB-INF/ui/html/<domain>.

3. Make the required changes in XSL files as explained in the chapter Chapter 7, Customizing General Features in Address Book.

   Although all images are located under <uwc-deployed-path>/absimx by default, you may create a directory with a domain name (For example <uwc-deployed-path/absimx/siroe.com) under it and include the icons that are customizable under the newly created domain directory. Also ensure that the path reference to the newly created directory is updated in <uwc-deployed-path>/WEB-INF/ui/html/<domain> search-images.xsl and commonimages.xsl.