uwc.gzipcompression

true

Enables GZIP compression on the Communications Express HTTP response.

Set this value to true to enable GZIP compression of the HTTP response. Enabling GZIP compression improves the throughput of the Communications Express page access.

uwc.renderhtml

n

Specifies whether Calendar Server should to render data in HTML format.

Set this value to y to render the calendar data in HTML format.

manual_purge_enabled

true

Enables a user with jsessionid to invoke the Address Book Server command, purge_entries.wabp, and permanently delete all entries marked for deletion.

auto_purge_enabled

false

Automatically purges contacts that are marked for deletion when login.wabp is invoked.

Set this value to true to enable automatic purge of contacts when login.wabp is invoked.

expire_period

0

Specifies the purge period in days, after which entries marked for deletion are permanently deleted.

This parameter is valid only when auto_purge_enabled is set to true.

purge_interval

30

Specifies the purge interval in days.

The purge cycle is triggered at the interval specified here only when auto_purge_enabled is set to true.

addressbook.wabp.version

1.0

Specifies the address book protocol version.

defaultdomain

Specifies the default domain to be used when the domain does not have the required properties, the properties are picked up from the default domain name.

The attribute default domain is assigned the value entered during configuration.

defaultlocale

en

Specifies the default locale to be used by the application.

virtualdomain.mode

Specifies whether Communications Express is operating in virtual domain mode.

Enable this option if you have enabled hosted domain support for Calendar Server.

The virtualdomain.mode is assigned the value entered during configuration.

uwcauth.ssl.enabled

false

Specifies whether SSL should be enabled.

uwcauth.ssl.authonly

false

Specifies whether SSL is enabled for SSL only.

uwcauth.admins

Specifies a list of administrator user ids. Multiple administrators can be defined and should be comma separated. This parameter is commented out by default. The administrator user ids should be in the form of uid@domain. For the default domain, you can ignore the domain related information. For example, if your default domain is siroe.com, the administrator for this domain can be admin. For non-default domains, the administrator user ids should be completely specified. For example admin@example.com. Here, admin is the administrator for example.com.

Parameters

Default Value

Description

defaultserver.ldappoolmin

Specifies the minimum number of LDAP client connections.

defaultserver.ldappoolmax

Specifies the maximum number of LDAP client connections.

defaultserver.ldappooltimeout

Specifies the number of seconds before timing out an LDAP connection. Increase this value to accommodate large search results.

defaultserver.ldaphost

Specifies the LDAP host.

defaultserver.ldapport

Specifies the LDAP port.

defaultserver.ldapbinddn

cn=Directory Manager

Specifies the DN used to bind to the LDAP.

If the login type is “restricted” or “proxy” it is mandatory to assign a value to defaultserver.ldapbinddn.

If the login type is “anonymous” you need not enter a value for this parameter.

defaultserver.ldapbindcred

Specifies the bind password.

entry_id

uid

Specifies the key in LDAP used to identify a contact/group entry.

You can set the entry_id to the UID or to the key used to fetch the contact/group information such as empid or principal ID.

In the xlate-inetorgperson.xml file replace “uid” in <entry entryID= “db:uid”\> with the entry_id value specified here.

retrieve_db_attribs

Defines whether all the database attributes should be passed in the LDAP search. This parameter can be either True or False.

lookthru_limit

1000

Specifies the search query limit for a search.

delete_perm

Enables contact/group entries to be marked for deletion or to be deleted permanently.

Set the parameter to false to mark the contacts/groups for deletion.

Set the parameter to true to permanently delete the contacts and groups.

admin_group_dn

Specifies the DN of the admin group.

A user belonging to this group can purge all contacts that are marked for deletion.

login_type

restricted

Specifies the method using which the connection to the LDAP store is maintained.

You can assign the following three values to this parameter:

anon - to connect to the LDAP as an anonymous user

restricted - to connect as a user who has the rights to perform operations on the Address Book Store.

proxy - to masquerade as a user who can perform operations on the Address Book Store. Assigning this value enhances performance as it by passes the LDAP bind on each operation.

NOTE: A Read only access is given to a masquerading user.

collation_rule

en-US

Specifies the collation rule that should be used. This parameter is commented out by default in the property file.

search_fields

entry/displayname

Specifies the search fields for which the collation rule should be applied. This property is disabled by default. This property should be uncommented if the collation rules have to be applied.

mail.deployed

This parameter is set to true if Mail is deployed. The parameter is set when you run the configuration wizard.

webmail.cookiename

If local.service.http.cookiename is set in webmail then value of this parameter should be same as local.service.http.cookiename.

webmail.host

Specifies the host on which the Messaging Server's HTTP service is running.

webmail.port

80

Specifies the port number Communications Express HTTP Server listens to.

webmail.securedproxyauth

Specifies whether Communications Express should authenticate a user in web mail server over SSL mode. If set to true, the authentication is done in SSL mode, and non-SSL mode if set to false.

webmail.proxyadmin

admin

Specifies the proxy administration user id.

webmail.proxyadminpasswd

Specifies the encrypted proxy administrator's password in encrypted format.

webmail.ssl.port

Specifies the mail (HTTPS) server port.

calendar.deployed

Specifies whether the calendar module is deployed. The parameter is set when you run the configuration wizard.

The attribute is set to “true” if Calendar is deployed.

calendar.wcap.host

Specifies the host name of the WCAP server.

calendar.wcap.port

Specifies the port number WCAP listens to.

calendar.wcap.adminid

calmaster

Specifies the administrator user idfor the WCAP Sever.

calendar.wcap.passwd

Specifies the administrator password for the WCAP Server.

calendar.jcapi.serviceclass

.socs

com.sun.comclient.calendar.

socs.SOCSCalendarStore

Specifies the name of Class implementing Java API for Calendar JCAPI, for Sun Java System Calendar Server.

Note: Do not change this value.

uwc.gzipcompression

Enables GZIP compression on the Communications Express HTTP response.

Set this value to true to enable GZIP compression of the HTTP response. This improves the throughput of the Communications Express page access.

uwc.renderhtml

Specifies whether calendar data needs to be rendered in HTML.

The parameter is set to 'y' if calendar data is to be rendered in HTML.

Valid values are 'y' or 'n'.

log.file

This parameter is used by Address book module.

/tmp/trace.log

Species the location of the log file.

By default messages go to the web container error log file.

log.level

This parameter is used by Address book module.

0

Specifies the log level for the application. To disable logging for this module, set the value to 0.

The valid values are:

!evel = 0 (off), 1 (debug only), 2 (error only), 3 (all).

log.components

This parameter is used by Address book module.

127

Specifies the component level for logging.

maxpostcontentlength

1000000

Specifies the maximum content-length of a POST command with a content-type of multipart/form-data (for file upload) in octets.

-1 refers to no limit.

uwcloginpath

/base/UWCMain

Specifies the path to the Communications Express login page.

sessionobjfactory.pstore.class

com.iplanet.iabs.coresrv.

CorePersonalStoreFactory

Defines the class implementing the SessionObjectFactory

loginpagetemplate

login.xml

This parameter is used by Communications Express to log on to the Address Book component of the user. The login.xml file is available in uwc-deployed-path/ui/html/

sessionobjfactory.pstore.

configpath

Specifies the plug-in configuration path. The path is either relative to the path of the current file or absolute to the path of the current file.

sessionobjfactory.pstore.

sessionid

com.iplanet.iabs.pstore

Specifies the name under which the object should be stored in the user's session.

addressbook.wabp.version

Specifies the address book protocol version.

manual_purge_enabled

Enables a user with jsessionid to invoke the Address Book Server command, purge_entries.wabp and permanently delete all entries marked for deletion.

auto_purge_enabled

Automatically purges contacts that are marked for deletion when login.wabp is invoked.

Set this value to true to enable automatic purge of contacts when login.wabp is invoked.

expire_period

Specifies the purge period in days, after which entries marked for deletion are permanently deleted.

This parameter is valid only when auto_purge_enabled is set to true.

purge_interval

Specifies the purge interval in days.

The purge cycle is triggered at the interval specified here only when auto_purge_enabled is set to true.

uwc.homepageurl

Specifies the Home Page URL.

When the users click the home link, they are taken to this URL.

In the absence of this parameter, home link will take the user to the user's default application.

mailfiltermaxmailcount

2

Specifies the number of mail filters you can have

is_passwd_encrypted

true

Specifies whether passwords are encrypted.

defaultdomain

Specifies the default domain to be used when the domain does not have the required properties. The properties are picked up from the default domain name.

The default domain is assigned the value entered during configuration.

defaultlocale

Defines the default locale of the application.

virtualdomain.mode

Defines the mode in which calendar server is operating. If the calendar server is operating in hosted (also known as virtual) domain mode, set the parameter value to 'y' otherwise to 'n'.

uwcauth.ssl.enabled

Defines if SSL is enabled.

uwcauth.ssl.authonly

Defines if SSL is enabled for authentication only.

ldapauth.ldaphost

Specifies the LDAP host value.

Normally the ldapauth.ldaphost value is the same as the ldapusersession value. You can set it to a different value, if required.

ldapauth.ldapport

Specifies the LDAP port number.

ldapauth.dcroot

Specifies the DC root for the authentication tree.

ldapauth.domainattr

inetDomainBaseDNinetDomainStatusinetDomainSearchFilterdomainUidSeparatorpreferredLanguage

Specifies the list of attributes to be retrieved from the domain entry in which the user is authenticated.

ldapauth.domainfilter

(|(objectclass=inetDomain)(objectclass=inetDomainAlias))

Specifies the filter based on which the domain entry is retrieved.

ldapauth.ldapbinddn

<binddn\>

Specifies User DN of the user binding to the authentication LDAP.

ldapauth.ldapbindcred

<binddncredintials\>

Specifies password of the user binding to the authentication LDAP.

ldapauth.enablessl

false

Specifies whether the directory against which authentication is to be performed is in SSL mode.

Change the default value to “true” to setup a secure LDAP connection.

ldapusersession.defaultugfilter

Specifies the default filter syntax to be used when retrieving the user entry.

Parameters for the user lookup

ldapauth.schema

Specifies the LDAP schema deployed during installation.

ldapusersession.ugattr

uid,inetUserStatus,preferredLanguage,psRoot,pabURI,cn,mail,mailHost

Specifies the set of attributes to be returned from LDAP during entry lookup.

ldapusersession.ldaphost

Specifies the Host name of the directory server used for users lookup. More than one host can be specified for fallback.

The names of the servers are delimited by semicolon (;).

!The name of fallback servers should be in the format: Host Name: PortNumber

ldapusersession.ldapport

Specifies the port number of the user/group directory server.

ldapusersession.ldapbinddn

Specifies the UserDN of the admin binding to the user group Directory Server.

ldapusersession.ldapbindcred

Specifies the password of the admin binding to the user tree.

ldapusersession.dcroot

Specifies the Domain Component (DC) tree in the user/group LDAP that is used to resolve a user entry in Sun Java System LDAP Schema v.1.

ldapauth.basedn

Specifies the LDAP base domain name value.

ldapusersession.domainfilter

(|(objectclass=inetDomain)(objectclass=inetDomainAlias))

Defines the filter used to identify a domain entry.

ldapusersession.ldappoolmin

Specifies the minimum number of LDAP client connections maintained.

ldapusersession.ldappoolmax

Specifies the maximum number of LDAP client connections maintained.

ldapusersession.ldappooltimeout

Specifies the number of seconds before timing out an LDAP connection.

Increase this value to accommodate large search results.

ldapusersession.enablessl

Specifies whether the directory against which authentication is to be performed is in SSL mode.

Change the default value to “true” to setup a secure LDAP connection.

Common Auth Configuration

uwcauth.sessioncookie

JSESSIONID

Specifies the name of the cookie used by the servlet container to monitor sessions.

This value should not be changed.

uwcauth.appprefix

Specifies the prefix for the host application used to find cookies generated by other trusted applications for single sign-on.

If the deployment uses Messaging SSO, this attribute should be assigned the value of local.webmail.sso.prefix set during messaging server configuration.

uwcauth.appid

uwc

Specifies the cookie name containing the unique application ID for the host application.

messagingsso.appid

ims

Communications Express uses this cookie to determine whether to issue the logout request to Messenger Express.

The value of messagingsso.appid should be same as the value of local.webmail.sso.id set during messaging configuration.

uwcauth.cookiedomain

Specifies the domain or path saved as part of the single sign-on cookie.

MessagingSSOAuth Filter Configuration

uwcauth.messagingsso.enable

Enables or disables messaging single sign-on functionality.

Set this parameter to “true” to enable single sign-on and “false” to disable single sign-on.

Make sure that uwcauth.messagingsso.enable is set to “false” when setting up Communications Express for Access Manager Single Sign-On.

uwcauth.messagingsso.cookiepath

/

Specifies the URI for which the single sign-on cookie is saved.

messagingsso.ims.url

http://servername:MessagingServerPort/VerifySSO?

Specifies the URL used to verify the SSO cookie.

The value of xxx should be replaced by the application ID of the server.

The value of xxx mentioned here should be identical to the value assigned in Messenger Express to local.webmail.sso.id.

messagingsso.uwc.url

http://servername:85/uwc/VerifySSO?When Communications Express is not deployed under “/”, such as /uwc, the value of the parameter may look like:

http://servername:85/uwc/VerifySSO?

Specifies the verify URL of Communications Express.

If you have edited the value of uwcauth.appid for this server, replace uwc in messagingsso.uwc.url with the new uwcauth.appid.

Identity SSO

uwcauth.identity.enabled

Specifies whether Access Manager is enabled.

Set the attribute to “true” to enable Access Manager. Set the attribute to “false” to disable Access Manager. Initially the value is set in the configurator.

uwcauth.identity.login.url

http://nicp160.india.sun.com:99/amserver/UI/Login

Specifies the Login Page URL of the Indentity Server

uwcauth.identity.binddn

Specifies the complete DN of the amadmin.

For example,

uid=amAdmin, ou=People, o=siroe.example.com, o=example.com

Note: The uwcauth.identity.binddn and uwcauth.identity.bindcred values should correspond to the values entered when installing Access Manager.

For example, uwcauth.identity.binddn=uid=amAdmin, ou=People, o=siroe.example.com, o=example.com and uwcauth.identity.bindcred=password.

uwcauth.identity.bindcred

Specifies the password of the amAdmin.

uwcauth.identity.cookiename

iPlanetDirectoryPro

Specifies the Access Manager session cookie name.

Ensure that in the uwcauth.properties file, the value of uwcauth.identity.cookiename is set to the value of local.webmail.sso.amcookiename.

uwcauth.http.port

80

Specifies the port number that Communications Express listens to when Communications Express is configured on a non SSL port.

uwcauth.https.port

443

Specifies the HTTPS port number that Communications Express listens to when Communications Express is configured on Web Server.

uwcauth.identitysso.cookiepath

/

Specifies the Identity SSO Cookie Path

identitysso.singlesignoff

Enables or disables identity single sign-on functionality.

If this attribute is set to true, all applications participating in this IS session are signed out when the users logs out.

If this attribute is set to false, only Communications Express session is disabled and the user will be taken to the URL configured in identitysso.portalurl.

identitysso.portalurl

Specifies the verify URL of Communications Express.

If Access Manager is enabled and single sign-off is set to false, Communications Express displays the identitysso.portalurl.

pab_mig_required

true

Specifies whether the address book directories should to be migrated.

Set the attribute to ”true’ if PAB migration is required otherwise set the parameter to 'false'.

[fully qualified virtual hostname of uwc].isvirtualhostname

When Communications Express is configured with Access Manager SDK in a remote set up, you need to specify the fully qualified virtual hostname of the desired virtual host to the virtual hostname of the Access Manager server.

uwc.logging.enable

no

Enables or disables logging. To enable logging, change the default value to yes.

uwc.log.file

/var/opt/SUNWuwc/logs/

uwc.log

Specifies the location of the log file.

Change the location of the file if required.

uwc.log.level

INFO

Specifies the log level for the application. Change the log level for the application to the desired level.

The log level values available are:

WARNING, INFO, and FINE, SEVERE.

uwc.log.formatter

SimpleFormatter

Describes the configuration information for Handlers.

By default, the formatter is the SimpleFormatter. You could also specify XMLFormatter

uwc.log.maxsize

0

Defines the maximum logfile size in megabytes. Communications Express will roll over to a new log file when the current file reaches this size, approximately. Default value is 0, that is, the log file size is unbounded.

uwc.log.maxfiles

5

Defines the maximum number of log files to retain, when rollover is enabled.

Global options

uwc-user-attr-locale

en

Specifies the default locale used for the domain.

uwc-user-attr-sunUCDefault

Application

addressbook

Specifies the default page to be displayed after you login. The available options are: mail, calendar, and addressbook.

uwc-user-attr-sunUCTheme

uwc

Specifies the default display theme.

Note: Currently Communications Express supports per domain theme, but do not support per user themes.

Refer to Sun Java System Communications Express Customization Guide for more details.

uwc-user-attr-sunUCColorScheme

2

Specifies the default display color scheme.

uwc-user-attr-sunUCDefaultEmailHandler

uc

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-sunUCTimeFormat

12

Specifies the time display format. The available formats are 12 or 24 hour formats.

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.

supportedLanguages

Specifies 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, en;es;de;fr;ja;ko;zh-CN;zh-TW

User's Calendar Options

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 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

• 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

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) the last day of the week.

uwc-user-attr-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

true

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-ceSingleCalendarTZID

0

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

Change the default value to 0 if you do not want to view calendars in the calendar’s time zone. When the value is set to zero, all calendars will be displayed in the time zone specified in the Global Options tab.

uwc-user-attr-icsExtendedUserPrefs-ceAllCalendarTZIDs

0

Defines the boolean value, which specifies that the time zone of all the displayed calendar should be used instead of the user's time zone.

uwc-user-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

1

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

uwc-user-attr-icsExtendedUserPrefs-sunCalEventfilter

Defines the default invitations to be viewed in the calendar.

The options available are: accepted, tentative, declined, and needs-action.

Address Book Default Option Values

uwc-user-attr-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 of 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-abSearchDisplayColumn2

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

primaryphone

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

You can set the display column name to:

• displayname

• company

• primaryphone

• workphone

• homephone

• faxphone

• pagerphone

• 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

• edit

• viewcalendar

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.

db.psrootattribute

psRoot

Defines the psRoot Attribute name.

db.useUserPsRoot

false

Specifies whether value for each User psRoot should be used . Set the attribute to true to use the attribute. Otherwise set the attribute to false.

db.defaultpsrootpattern

Specifies the default psRoot pattern to be used when db.useUserPsRoot attribute is set to true.

For example,

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

db.psurlprefix

ps

Defines the protocol prefix of ps URLs

db.defaultpspath

defaultps

Defines the path where the defaultps values are stored. There exists one path for each domain with dictionary files for each locale.

db.maxpagedsearch

Specifies the maximum number of simultaneously paged search for an instance of Personal Store.