Communications Express 6.3 Initial Configuration

Skip to end of metadata
Go to start of metadata

Completing the Sun Java System Communications Express 6.3 Installation: Initial Configuration

This chapter describes the configuration and migration steps you must perform, after installation, before you can use Communications Express.

This document includes the following sections:

Before You Begin

Before you configure Communications Express, make sure you have the following dependent components installed and configured:

  • Directory Server.
  • Messaging Server and Calendar Server. Make sure you have recorded the relevant details about the installations, such as the hostname, port number, administrator username and password.
  • Be sure you have run the Comm Directory Server set-up script, comm_dssetup.pl.

Communications Express File Directory Layout

After you install and configure Communications Express, the related files and directories are arranged in the organization as shown in Table 2-1. The table is not exhaustive. It shows only the required directories and files for typical server administration tasks.

Table 2-1 Communications Express Directories and Files
Directory and Legends Default Location and Description
Communications Express Base

uwc-basedir
Default location:

Solaris™: /opt/sun/comms/ce/

Linux: /opt/sun/comms/ce/

Communications Express is installed in this directory.

Note: On Solaris OS 10, the Communications Suite installer allows multi-installation of Communications Express; you can install multiple Communications Express base directories per machine. On Linux, only one Communications Express base directory is permitted.
Deployed Directory

uwc-deployed-dir
Default location:

Solaris: /var/opt/comms/ce/

Linux: /var/opt/comms/ce/

Communications Express is deployed in this directory. The web container takes the files from this location while loading Communications Express.
Web Applications Root Directory

WEB-INF
uwc-deployed-dir/WEB-INF

WEB-INF directory of Communications Express web application
Webmail directory uwc-deployed-dir/webmail

Contains all the webmail related files that Communications Express uses.
Configuration

config
uwc-deployed-dir/WEB-INF/config/

Contains all the Communications Express configuration files
Domain

domain
uwc-deployed-dir/WEB-INF/domain/

Contains per domain localization and Customization files
Skin

skin
uwc-deployed-dir/WEB-INF/skin/

Contains per domain themes
Logs

logs
uwc-deployed-dir/logs/

Contains the Communications Express log files. By default log messages are saved to the Web Server's error log file. You can change this location by setting the log.file configuration parameter in the uwcconfig.properties file.
System Administrator Programs

sbin
uwc-basedir/sbin/

Contains the Communications Express system administrator executable programs and scripts
Help

help
uwc-deployed-dir/help

Contains Communications Express help files

Prerequisites for Configuring Communications Express

Before running the Communications Express configuration wizard, make sure you:

  • Choose your schema. Refer to the section on Schema Choices for information on the available schema.
  • Ensure that you have the following entry in the /etc/hosts file on your Solaris system:

    ip-of system Fully-Qualified-Hostname

    For example,

    129.158.230.64 budgie.siroe.varrius.com budgie
  • Ensure that the following components are up and running before you configure Communications Express. Make sure that the configuration of the products for Communications Express is done in the following order:
    • Directory Server
    • Application Server or Web Server
    • Access Manager, if Communications Express wants to participate in SSO (Single Sign On) with other products (For example, Portal Server).
      Note
      The Web Server that is hosting Communications Express should be running as root when configuring for Remote AM SDK deployment.
    • Messaging Server
    • Calendar Server
    • Delegated Administrator if you have chosen Sun Java System LDAP Schema, v.2
  • Verify whether users are able to log in to the following servers correctly:
    • Messaging Server
    • Calendar Server
    • Access Manager (formerly known as Identity Server), if you want Communications Express to participate in SSO with other products

Schema Choices

Prior to installing and configuring, you will need to decide on the schema model you wish to adopt. You have two schema and web container options available when deploying Communications Express.

  • Sun Java System LDAP Schema, v.1
  • Sun Java System LDAP Schema, v.2

The configurator screen displayed for each schema and web container combination varies depending on your schema and web container selection. Appendix A, Configuration Panel Sequence, in the Sun Java System Communications Express 6.3 Administration Guide, lists the screens that are displayed for each schema and web container combination.

Invoking Configuration Wizard

This section describes how to invoke the configuration tool

To Invoke the Configuration Wizard
  1. Log in as Administrator (root for UNIX or Linux).
  2. Before invoking the configuration wizard set the display settings.
  3. Go to INSTALLROOT/ce/sbin directory.
  4. Type the following at the command prompt to invoke the configuration wizard:

    ./config-uwc to invoke the configuration tool in the GUI mode.

    ./config-uwc -nodisplay to invoke the configuration tool in the console mode.
    Note
    This chapter discusses configuration of Communications Express in GUI mode.
    Note
    This version does not support the silent installation mode.

Configuring Communications Express

The following steps walk you through configuring Communications Express.

Note
If you are invoking the configuration wizard in a language other than English, resize the configuration screen to view its contents properly.
To Configure Communications Express
  1. Run the configuration wizard by following the steps in Invoking Configuration Wizard.
    The Welcome screen appears. Click Next. The Select the Directory to Store Configuration and Data Files screen appears.

  2. Select the directory in which the configuration and data files for Communications Express should be deployed.
    For example, /var/opt/sun/comms/ce. This directory is referred as uwc-deployed-path throughout this guide.
    Click Next. The Select Components to be Configured screen appears.

  3. Select the components you want to configure and deselect those components you do not wish to configure.
    The following components are available:
    • Mail Component
    • Calendar Component
      Note
      You have to select at least one component from the Select Components to be Configured screen.

      Although the component size is displayed as zero, the Mail and Calendar components are installed.

      Click Next. The Network Connection screen appears. The configuration program tries to establish network connection by using the host name and the DNS domain name displayed in this screen.

      Host Name: Displays the host name on which Communications Express is being configured

      DNS Domain Name: Displays the DNS domain name maintained by the DNS Server
      Click Next. The Select a Web Container screen appears.

  4. Select the web container you want to use.
    The options available are:
    • Web Server
    • Application Server
      Click Next.
      If you have selected Web Server as your web container, the following screens appear.

    • Configure the Web Server by performing the following steps.

      The Web Server Configuration Details screen appears first.
      • Specify the local Web Server instance details.
        • Server Root Directory: Browse to select the installation root of the Web Server. Default location is /opt/SUNWwbsvr7/.
        • Server Instance Identifier: Enter the Web Server instance on which Communications Express is to be deployed. For example, budgie.siroe.varrius.com.
        • Virtual Server Identifier: Enter the virtual server identifier on which Communications Express is to be deployed. For example, https-budgie.siroe.varrius.com.
        • HTTP Port: Enter the HTTP port number Web Server listens to. The Web Server listens to this HTTP port number when Communications Express is accessed.
          Note
          If you want to configure a secure HTTP port number, specify it after configuring Communications Express. To configure a secure port number see Configuring Secure Socket Layer.

          Click Next. The configuration wizard checks if the Web Server connection instance is alive. If the Web Server instance is not up and running, an error message appears. Refer to Prerequisites for Configuring Communications Express to know more about the prerequisites required before configuring Communications Express.

The Web Server Administration Instance Details screen appears.

      • Specify the Administration Instance Details.
        The following options are available
        • Administration Server Port: Enter the Web Server administration server port number.
        • Administration Server User ID: Enter the Web Server administrator user ID.
        • Administration Server Password: Enter the Web Server administrator password.
          You will see a small popup window indicating that the Web Server Instance is being verified. This may take a few minutes.

          If the configuration wizard is unable to connect to the Web Server Instance, an error message is displayed. Click Accept, to continue with the installation process, or click Choose New, to specify different Web Server configuration details.

          Click Next. The Web Container User and Group screen appears.

      • Specify the identity, the web container uses to run the services.
        • Web Container User ID: Displays the web container user identifier from the user database.
        • Web Container Group ID: Displays the web container group identifier from the group database.
          Click Next. The configuration wizard installs some files and directories containing sensitive data, such as passwords. The ownership of these files and directories are given to web container user and group mentioned in this screen. Only the web container user is given read and write permissions to the files and directories containing sensitive data.
          Note
          Ensure you enter the correct web container User ID and Group ID values in this screen. Entering wrong values may result in startup failure of the Communications Express.

          Click Next.

    • If you have selected Application Server to be your web container, the following screens appear:

      Configure Application Server by performing the following steps. The Application Server Configuration Details screen appears first.
      • Specify the Application Server Configuration Details that the configuration wizard can use to configure Communications Express with Application Server.
        • Install Directory: Browse to select the local directory in which Application Server is installed.
        • Domain Directory: Browse to select the domain directory of the Application Server.
        • Document Root Directory: Browse to select the document root directory of the Application Server.
        • Server Target Name: Enter a name for the Application Server target, for which Communications Express is to be configured. The Communications Express configuration wizard supports only the Domain Administration Server (DAS) deployment for Application Server .
        • Virtual Server Identifier: Enter the virtual server identifier for which Communications Express is to be configured.
        • Server Instance HTTP Port: Enter the Application Server port number where an HTTP service is available. This is the HTTP port from which Communications Express application will be accessed.
          Note
          Specify the HTTP Port number here. If you want to configure a secure HTTP port number, specify it after configuring Communications Express. To configure a secure port number, refer to the post configuration steps provided in the section Configuring Secure Socket Layer.

          Click Next. You will see a popup window indicating that the Application Server Instance is being verified. This may take a few minutes. An Error message is displayed if the configure tool is unable to connect to the Application Server Instance. Click Accept, to continue with the installation process, or click Choose New, to specify the Application Server Configuration Details again. When the configuration wizard successfully verifies the Application Server instance, the Application Server instance Details screen is displayed.

      • Specify the administration instance details of the Application Server.

        The administration instance details are used by the configuration wizard to deploy Communications Express on Application Server:
        • Administration Server Port: Enter the Administration Server port number.
          Note
          The administration port of the Application Server that you specify must be available for configuring Communications Express on Application Server.
        • Administrator User ID: Enter the administrator’s user identifier.
        • Administrator Password: Enter the administrator’s user password.
        • Secure Administration Server Instance: Select this option to specify that the Application Server’s administration instance is running in the secure mode. Deselect the checkbox, to specify that the Application Server’s administration instance is running in the normal mode.
          Depending on the selection, a popup window confirming the mode in which the Application Server’s administration instance is running appears. Click OK to exit the popup window.
          Note
          When deploying Communications Express on the Application Server, two files, server.xml and server.policy, are modified. Before modifying the server.xml and server.policy files, a backup of these files is maintained by the configuration wizard. The backup files are stored in the directory: DOMAIN-DIRECTORY/ SERVER-INSTANCE-NAME/config/.CommsExpress_YYYYMMDDhhmmss
          Here:
          • DOMAIN-DIRECTORY is the Application Server’s domain directory.
          • SERVER-INSTANCE-NAME is the Application Server Instance Name for which Communications Express is being configured.
          • YYYYMMDDhhmmss is the time stamp of the backup directory.

          Click Next. The Module Name for this Web Application screen appears.

      • Enter the module name with which Communications Express should be deployed on Application Server.
        The configuration wizard has now collected the required parameters to configure Communications Express with the web container of your choice.

        Click Next. The Web Container User and Group screen appears.
  1. Specify the identity, the web container uses to run the services.
    • Web Container User ID: Displays the web container user identifier from the user database.
    • Web Container Group ID: Displays the web container group identifier from the group database.
      Click Next. The configuration wizard installs some files and directories containing sensitive data, such as passwords. The ownership of these files and directories are given to web container user and group mentioned in this screen. Only the web container user is given read and write permissions to the files and directories containing sensitive data.
      Note
      Ensure you enter the correct web container User ID and Group ID values in this screen. Entering wrong values may result in startup failure of the Communications Express.

      Click Next. The URI Path Setting screen appears.

  2. Enter the URI where Communications Express should be deployed.

    For example, /uwc
    Caution
    If you are using an existing URI to deploy Communications Express, the configuration tool first removes any previous application data before deploying Communications Express on that URI. For example, if you are deploying Communications Express on a URI such as /uwc that has a web application deployed in it, Communications Express configurator first removes the existing web-application from /uwc before deploying Communications Express. This could result in the loss of the previous application’s data and accessibility of the application.

    Click Next. The Do you want Hosted Domain Support? screen appears.

  3. Select the option to enable hosted domain support for Communications Express.

    Select this option only if you have enabled hosted domain support in Calendar Server.

    Click Next. The User/Group Directory (LDAP) Server Details screen appears.
  4. Enter the following details:

    LdapURL: Specify the user or group LDAP URL in the format ldap://UG-LDAP-HOST:UG-LDAP-PORT where:
    • UG-LDAP-HOST is the LDAP hostname
    • UG-LDAP-PORT is the LDAP port number
      Bind DN: Enter the LDAP distinguished name of the User/Group administrator.

      Bind Password: Enter the bind password for User/Group administrator.

      Click Next. The DC Tree Suffix screen appears.
  5. Enter the base distinguished name for the DC tree suffix.

    This suffix is used by the Communications Express to search for domain lookup.

    Click Next. The Default Domain Name screen appears.
  6. Enter the default domain name.

    Each domain has certain properties. When a user logs into a domain that does not have the required properties, the properties are picked up from the default domain name.

    Click Next. The Enable Access Manager for Single Sign-on screen appears.
  7. Select Enable Identity Support for Communications Express if you want to enable Access Manager for Single Sign-on.

    Only if you have enabled Identity Support for Communications Express, the Access Manager Preferences screen is displayed.

    Enter the Access Manager Preferences such as the login URL, Access Manager Administrator DN and Password in this screen.
    • Admin DN: Enter the complete LDAP DN (distinguished name) of the Access Manager Administrator, such as DN=uid=amAdmin, ou=people, Access Manager- root suffix.
    • Admin Password: Enter the password for the Access Manager administrator.
      Click Next. The Messaging Express Port screen appears.
  8. Specify the Messaging Server related parameters.
    This screen appears only when the mail component is selected in the Select Components to be Configured screen.
    The following options are available:
    • Webmail Server Hostname: Specify the hostname where the webmail server is installed.
    • Webmail Server Port Number: Specify the port number which the Messaging Server HTTP (mshttpd) port number listens to. For example, the default is: 8990.
    • Enable login in secure mode: Select this option if you want users to log in secure mode.
    • Webmail Server SSL Port Number: If you have configured Webmail Server to run in SSL mode, enter the SSL port number.
    • Webmail Admin User ID: Specify the administrator user ID for the Webmail Server.
    • Admin Password: Enter the administrator password for webmail.
      Click Next. The Calendar Server Host and Port Configuration screen appears.
  9. Specify the Calendar Server host and port.
    This screen appears only when calendar component is selected in the Select Components to be Configured screen.
    The options available are:
    • Calendar Server Host Name: Enter the Calendar Server’s host name.
    • Calendar Server HTTP Port Number: Enter the Calendar Server’s HTTP port number.
      Click Next. The Calendar Server Administration Details screen appears.
  10. Enter the Calendar Server user ID and password.
    • Administrator User ID: Enter the Calendar Server’s administrator’s name. For example, calmaster.
    • Administrator User Password: Enter the Calendar Server’s administrator’s password.
      Note
      Ensure that the Calendar Admin User ID value you have entered here is the same as the service.admin.calmaster.userid value mentioned in Calendar Server’s ics.conf file.

      Click Next. The PAB Directory Server Details screen appears.

  11. Specify the details where the PAB entries are stored in the LDAP server.
    The Personal Address Book LDAP Server is the store where users personal address books are located. Enter the following details in this screen:
    • LDAP URL: Specify the LDAP host and port for the PAB Store. The URL should be in the format: ldap://PAB-ldap-hostname:PAB-ldap-portnumber
    • Bind DN: Enter the LDAP DN to be used to bind to the PAB Store. The Bind DN specified here should have appropriate privileges to manage the data under root suffix o=PiServerDB.
    • Password: Enter the bind password.
      Click Next. The Ready to Configure screen appears.

      The configuration program checks for enough disk space on your machine and then lists the components it is ready to configure.
    • Click Configure Now, to configure Communications Express.
    • Click Back, to change any of your configuration variables.
    • Click Cancel, to exit from the configuration program.
      If you clicked Configure Now, a summary of tasks and the sequence status is displayed. Click Next. The Configuration Summary screen lists the status of the configuration program. Click Details button to view the log.

      The Post Configuration Instructions screen appears only when the configuration is successful. This screen may display warning messages when the required shared components are not installed. In order to complete the configuration process, follow the post-configuration instructions provided here.

Post Configuration Instructions

To complete the configuration process, follow the post configuration steps.

Note
Make sure you are familiar with the location of the Communications Express files. Refer to the section on Default Paths and File Names in the Sun Java System Communications Express 6.3 Administration Guide.

Refer to Chapter 3, Configuration Details in the Sun Java System Communications Express 6.3 Administration Guide for more details on the configuration parameters.
To Configure Communications Express After Installation

After installing Communications Express, ensure that for a setup using Access Manager single sign-on, the Core and LDAP services are added. For more information, refer to the section on Tuning LDAP Related Configuration Parameters in the Sun Java System Communications Express 6.3 Administration Guide.

After you have configured Communications Express, perform the following steps:

  1. Enable the Mail component in Communications Express by configuring Single Sign-On.

    Refer to Chapter 1, Overview of Communications Express in the Sun Java System Communications Express 6.3 Administration Guide for information on configuring Messenger Express and Communications Express.
    Use the configutil command to set the following parameters in the Messaging Server configuration file, msg.conf.
    For details about these parameters, see Messaging Server Configuration. For details about using the configutil command, see the Sun Java System Messaging Server 6.3 Administration Reference.
    • local.webmail.sso.uwccontexturi = context-uri-for-communications-express-installation
    • local.webmail.sso.uwcport = uwc-port-for-communications-express-installation
    • local.webmail.sso.uwcsslport = uwc—ssl-port-for-communications-express-installation
    • local.webmail.sso.uwcenabled = 1
  2. Go to calendar-server-install-directory/SUNWics5/cal/bin/config (For example, /opt/SUNWics5/cal/bin/config ).
    Edit the ics.conf file and set the following:
    • service.http.allowadminproxy = "yes"
    • service.http.admins = proxy-admin-for-calendar-http-service
    • service.admin.calmaster.userid = the-value-specified-for- calendar.wcap.adminid-in-uwcconfig.properties
    • service.admin.calmaster.cred = the-value-specified-for- calendar.wcap.passwd-in-uwcconfig.properties
    • service.wcap.anonymous.allowpubliccalendarwrite = "yes"
    • service.http.allowanonymouslogin = "yes"
    • service.calendarsearch.ldap = "no"
    • service.http.ui.enabled = "yes"
      If you have edited the ics.conf file, restart Calendar Server for the changes to take effect.
  3. To enable Communications Express for Access Manager SSO, see Setting up Access Manager Single sign-on.
  4. Type the following commands to restart the Messaging Server.

    msg-svr-base/sbin/stop-msg

    msg-svr-base/sbin/start-msg
  5. Type the following commands to restart the Calendar Server.

    cal-svr-base/cal/sbin/stop-cal

    cal-svr-base/cal/sbin/start-cal
  6. Restart the web container.

    Communications Express is now ready and you can access the application from:
    http(s)://Web-Container-host:Web-Container-port/URI path

    where:
    • Web-Container-host is the host name of the web container instance in which the Communications Express application is configured.
    • Web-Container-port is port number of the web container instance in which the Communications Express is configured.
    • URI path is the path specified in the URI Path Setting screen.

Customizing the Landing Page of Communications Express

The landing page displayed after login can be customized by using a parameter called gotoUri. You can customize the landing page to display the Calendar, Address Book, or Options page. By default, the landing page of Communications Express displays the Mail page.

Note
This feature is available only if you have applied the patch version of Communications Express 6.3.

You can customize the landing page by using one of the following options:

  • Modifying the browser URL
  • Modifying the LDAP attribute
  • Modifying the server configuration parameter
Customizing the Landing Page by Using the Browser URL

To customize the landing page, you should add the gotoUri parameter to your browser URL in the following format:

http://host name:port number/uwc/?gotoUri=landing page choice

For example, to customize the landing page to display the Address Book page, type the URL in the following format:

Note
This customization applies only to the current session and needs to be reset for every session.
Customizing the Landing Page by Modifying the LDAP Attribute

The user LDAP (or Sun Java System Directory Server) entry has a multivalued attribute called sunUCExtendedUserPrefs. You can customize the landing page by adding the following value to the attribute:
landingPage=landing page choice
For example, landingPage=/abclient/AddressBook

Note
This customization applies to the user whose entry has been modified with the attribute, and needs to be added only once. However, you can override this customization by setting the gotoUri parameter in your browser URL.
Customizing the Landing Page by Modifying the Server Configuration Parameter

You can customize the landing page by adding the following configuration parameter in the uwcconfig.properties file:
uwc.gotoUri=landing page choice
For example, uwc.gotoUri=/abclient/AddressBook
The configuration file is located in the uwc-deploy-dir/WEB-INF/config directory on the server.

Note
This customization applies to all users and the configuration parameter must be added only once. However, you can choose to override the customization by using the previous options.

You can use the following configuration parameter values to set the landing page:

  • /abclient/AddressBook - to set the Address Book page as the landing page
  • /base/UWCMain?forwardtodefview=true - to set the Calendar page as the landing page
  • /base/MailOptions - to set the Mail Options page as the landing page
  • /base/CalendarPreferences - to set the Mail Options page as the landing page
  • /base/ABPreferences - to set the Address Book Options page as the landing page
  • /base/UserPreferencesSettings - to set the Global Options page as the landing page
Note
When you use more than one option to set the gotoUri parameter, the system takes the following configuration precedence:
  1. Browser URL
  2. User LDAP attribute
  3. Server configuration parameter

Undeploying Communications Express

To undeploy Communications Express from Web Server or Application Server, you need to undeploy the Communications Express web application. Please refer to the relevant documentation for Web Server and Application Server on how to undeploy an application.

Labels:
guide guide Delete
configuring configuring Delete
communicationsexpress communicationsexpress Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jan 28, 2008

    In JCS 5 service.http.ui.enabled is set to 'no' by default. My understanding was that this controls the old (non-CE) Calendar Server interface and that this interface was deprecated.

    If the meaning of service.http.ui.enabled has changed it might be good to notify potential readers in the Calendar Server or CE release notes unless the JCS 5 to JCS 6 upgrade process notes this and changes it

  2. Jan 28, 2008

    Same comment for Communication Center and the webmail server port: http://wikis.sun.com/display/CommSuite/Communication+Center+1.0+Initial+Configuration

  3. Jan 28, 2008

    Added default webmail port number, 8990.

  4. Feb 12, 2008

    On the point 1 of "Configure Communications Express After Installation"
    which file should be modified?

    1. Feb 12, 2008

      Hirva,

      Checking on your question. Will post the answer when I get it.

  5. Feb 12, 2008

    Hirva,
    We found the answer to your question. Please see the text.
    And thanks for your comment; it helps us to improve the document.

Sign up or Log in to add a comment or watch this page.


The individuals who post here are part of the extended Oracle community and they might not be employed or in any way formally affiliated with Oracle. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Oracle nor any other party necessarily agrees with them.