Communications Suite 6 Update 2 Installation Scenario - Convergence

h1. Communications Suite 6 Update 2 Installation Scenario - Install Convergence

h2. Assumptions

This scenario shows how to install an instance of the Convergence on a separate host or Solaris zone. It is based on the _Install Convergence_ leaf in the [Communications Suite 6 Update 2 Installation Flowchart]. The scenario makes these assumptions:

* You are deploying Communications Suite on multiple hosts or Solaris zones.
* This Convergence is one functional component of your multi-host deployment.
* The Communications Suite servers (Messaging Server, Calendar Server, Instant Messaging) are installed on separate hosts.
* If you are distributing multiple instances of the Convergence across several hosts, you can follow these instructions for each host on which you install the Convergence.

{note}
This scenario describes how to install the software that should run on the same host as Convergence.\\
For a list of all the products required for Convergence, including those installed on other hosts, see [Product Version Requirements for Convergence 1 Update 2|Communications Suite 6 Update 2 Component Products Release Notes#convergenceproductreqs].
{note}


h2. Which Software Components and Downloads Do You Need?

h4. Software Components:

To successfully configure and run Convergence on this host, you need to install the following software components:

h6. Required:

* *Sun Java System Application Server 9.1 Update 2 with High Availability Database (HADB) - Zip/File Based* \\
\\
* *Convergence 1 Update 2*

h6. Recommended:

* *Webmail Server component of Messaging Server 7 Update 2*

We recommend that you install the Webmail Server on this host.

h6. Optional, for SSO:

* Application Server 9.1 Update 2 with High Availability Database (HADB) - Zip/File Based
* Java ES 5 Update 1 distro: for Access Manager 7.1
* Communications Suite: for Convergence 1 Update 1 and Webmail Server

Download these software files from the Communications Suite download site. For details, see [Get the Software].

h4. Convergence Support for SSO

Convergence supports the following methods for implementing Single SignOn.
* Access Manager
* Messaging Server (Trusted Circle) SSO
* Sun OpenSSO Enterprise 8.0.

If you have a third-party authentication or SSO service, you can also customize the Convergence Server to create an authentication and/or SSO plug-in for that service. For details, see

* [Writing a Custom Authentication Module for Convergence|CommSuite:Writing a Custom Authentication Module for Convergence]
* [Writing a Custom SSO Module for Convergence|CommSuite:Writing a Pluggable SSO Module for Convergence]


h4. About Webmail Server

The best deployment practice is to place the Webmail Server on the same host as Convergence to provide horizontal scalability and enable smooth growth of services.

*Note:* From a functional perspective, Convergence provides complete mail service when the Webmail Server is located on a different host than Convergence. Therefore, in some deployments, the Webmail Server may be located on a different host.

Other Messaging Server components such as the message store and MTA, Calendar Server, and Instant Messaging Server may be located on other hosts.

h2. Which Task Sequence Do You Follow?

h4. Step 1. Install Application Server 9.1 Update 2 with High Availability Database (HADB) - Zip/File Based.

{note}
Download the Application Server software zip file from the Communications Suite download site. Do not install the version of Application Server bundled with JES 5 Update 1; that is an older version of Application Server.
{note}

Follow these guidelines:

* The high availability database (HADB) version provides shared components needed by Application Server and Communications Suite. You can configure this version of Application Server without using the HADB.

* The Communication Suite installer does not install Application Server.

* To install Application Server, follow the instructions in the [_Sun Java System Application Server 9.1 Installation Guide_|http://docs.sun.com/app/docs/doc/820-3797].

* Install Application Server before you install Access Manager and configure Convergence.

* To verify which version of Application Server you have installed, see [Verify Application Server Version|Verify Application Server Version].

h4. Step 2. Install Access Manager 7.1 SDK

Perform this task only if you intend to use Access Manager for authentication and/or SSO.

*Prerequisite:* This task assumes that Access Manager Server 7.1 is installed on a remote host.

If you already have Access Manager Server installed on _this_ host, you do not need to install the Access Manager SDK.

# Be sure that Directory Server Enterprise Edition 6.3 is installed and configured on another host in your deployment.
# Start Directory Server.
# Verify that Application Server 9.1 Update 2 is installed and running on this host.
# Verify that the full Access Manager 7.1 server is running and accessible, either on a remote host (or on another instance on the same host where you plan to install the Access Manager SDK).
# Log in as or become superuser ({{root}}).
# Launch the Java ES 5 Update 1 installer.
# When the Java ES installer displays the Choose Software Components Page, under Access Manager 7.1, select only the Access Manager SDK.
# Choose the *Configure Later* option for installing the Access Manager 7.1 SDK.\\
\\
{note:title=About the Configure Later Option}
If you install the Access Manager 7.1 SDK to Application Server 9.1 without installing the full Access Manager Server on this host, you must choose *Configure Later.* If you do not, the AM SDK does not work.
{note}
\\
{note:title=Realm Mode and Legacy Mode}
Convergence supports both Access Manager Realm mode (the default) and Legacy mode for providing authentication and SSO.
{note}

Follow the instructions in [_Deploying the Access Manager 7.1 SDK with Application Server 9.1_|http://docs.sun.com/app/docs/doc/820-3043/6nejrv3mk?a=view#gfnry].

For more information, see: [_Technical Note: Deploying Access Manager with Application Server 9.1_|http://docs.sun.com/app/docs/doc/820-3043/6nejrv3m2?a=view].

For information about the Java ES installer, see [_Sun Java Enterprise System 5 Update 1 Installation Guide for UNIX_|http://docs.sun.com/app/docs/doc/820-2827].\\
\\
For more details, see [_Access Manager Configuration Guide_|http://docs.sun.com/app/docs/doc/819-5899]. You can also find installation instructions in this [_Access Manager Deployment Example_|http://docs.sun.com/app/docs/doc/820-2278/gdssn?a=view].\\
\\

h4. Step 3. Before you install Messaging Server (Webmail Server component):

*Note:* Perform this task if you are installing Webmail Server on this host.

* Make sure you do not configure conflicting port numbers on a machine when various components are running on a single machine. For a list of port numbers used by Messaging Server, see [Default Port Numbers|Communications Suite 6 Update 2 Component Products Release Notes#GDWUB].

h4. Step 4. Install Convergence and Webmail Server:

# [Run the Communications Suite installer|Communications Suite 6 Update 2 Installation Guide#installcommssuite].\\
\\
# When the Comms Installer lists the components to install, choose the following components:\\
\\
* Convergence 1 Update 2 (Integrated Web Client)\\
\\
* Messaging Server. Choose the 32-bit or 64-bit version by selecting one of these components:\\
\\
** Messaging Server 7 Update 2 for the 32-bit version) \\
\\
** Messaging Server (64-bit) 7 Update 2 (for the 64-bit version) \\
\\
*Note:* Select Messaging Server only if you are installing Webmail Server on this host.\\
\\
Make sure that the other components are not selected.\\
\\

h4. Step 5. Configure the Webmail Server:

*Note:* Follow these steps if you are installing Webmail Server on this host.

# Use the following worksheet to gather configuration information for the Webmail Server: [Messaging Server 7 Update 1 - Configuration Worksheet|Configuration Worksheets - Messaging Server]\\
\\
# Run the Messaging Server initial configuration program:\\
\\
For 32-bit: {{# _INSTALLROOT_/messaging/bin/configure}}\\
\\
For 64-bit: {{# _INSTALLROOT_/messaging64/bin/configure}}\\
\\
For detailed instructions, see [Messaging Server 7 Update 2: Initial Configuration|Messaging Server 7 Update 2 Initial Configuration].\\
\\
When the Messaging Server {{configure}} program lists the components to configure, select\\
\\
Webmail Server\\
\\
Make sure that the other components are not selected.\\
\\
# Set the following {{configutil}} parameters. The Webmail Server uses these {{configutil}} parameters to log in to the back-end IMAP servers:

|| {{configutil}} Parameter|| Description||
|{{local.service.proxy.admin}} |Default backend store administrator login name. (Restart of HTTP service required; Restart of IMAP service required).
Syntax: string
Default: {{admin}}|
|{{local.service.proxy.adminpass}} | Default store administrator password. (Restart of HTTP service required; Restart of IMAP service required).
Syntax: string
Default: <_admin.password_>|
|{{local.service.imapport}} | Default IMAP port number for backend store servers. (Restart of HTTP service required; Restart of IMAP service required).
Syntax: integer
Default: 143|

Note that the Webmail Server can communicate with multiple back-end IMAP servers. If the IMAP servers use different values for these parameters are different, you must set individual {{configutil}} parameters for each host, as follows:

|{{local.service.proxy.admin.}}_hostname_|
|{{local.service.proxy.adminpass.}}_hostname_|
|{{local.service.imapport.}}_hostname_|

where _hostname_ is the name of the host on which each back-end IMAP server is running.

h6. Examples

For one back-end IMAP server:

{noformat}
configutil -o local.service.proxy.admin -v myadmin
configutil -o local.service.proxy.adminpass -v <password>
configutil -o local.service.proxy.imapport -v 143
{noformat}

For multiple back-end IMAP servers:

{noformat}
configutil -o local.service.proxy.admin.host1.siroe.com -v admin1
configutil -o local.service.proxy.adminpass.host1.siroe.com -v <password>
configutil -o local.service.proxy.imapport.host1.siroe.com -v 143

configutil -o local.service.proxy.admin.host2.siroe.com -v admin2
configutil -o local.service.proxy.adminpass.host2.siroe.com -v <password>
configutil -o local.service.proxy.imapport.host2.siroe.com -v 143
{noformat}

h4. Step 6. Before you configure Convergence, take these steps:

# Use the following worksheet to gather configuration information for the Convergence: [Convergence 1 Update 1 - Configuration Worksheet|Configuration Worksheets - Convergence]\\
\\
# If your Convergence deployment supports Instant Messaging (the chat component), you must configure the Httpbind JID and Avatar JID on Instant Messaging Server. Peform this step before you run the Convergence configuration program.\\
\\
For details, see [Configure IM Components to Enable Communication with the Instant Messaging Server|Convergence 1 Update 2 Initial Configuration#configimbackend].\\
\\
# Be sure that the back-end servers and web container are up and running:\\
* Directory Server\\
* Messaging Server\\
* Calendar Server\\
* Application Server 9.1 Update 2\\
\\
Verify whether users are able to log in to the back-end servers correctly:
* Messaging Server\\
* Calendar Server\\
\\

h4. Step 7. Configure Convergence:

# Run the Convergence initial configuration program:\\
\\
{{# _INSTALLROOT_/iwc/init-config}}\\
\\
# When you run the initial configuration program, specify the configuration values to connect to the back-end servers supported in your Convergence deployment:\\
* To support the Convergence mail component, configure values for the Webmail Server.\\
* To support the Convergence calendar component, configure values for the Calendar Server. \\
* To support the Convergence chat component, configure values for the IM Server. \\
\\
For detailed instructions, see [Convergence 1 Update 2: Initial Configuration|Convergence 1 Update 2 Initial Configuration].\\
\\