| Installation Guide: Sun ONE Portal Server Communication Channels |
Chapter 2
Installing Communication Channels on Portal Server 6.0 or 6.1This chapter describes the steps to install the Sun ONE Portal Server Communication Channels 6.0 on Sun ONE Portal Server 6.0 or 6.1.
Installation TasksThe following are the high-level tasks involved in setting up the communication channels:
If you already have Sun ONE Messaging Server 5.2, and Sun ONE Calendar Server 5.1.1 installed either on the same server or on different servers, specify the respective URL when you create a channel.
Installing Communication ChannelsThe download file contains useful information about the communication channels, such as:
- the readme.txt file.
- the Portal Server Communication Channels 6.0 packages.
- the installation scripts.
- a patch needed for installing the communication channels on Portal Server 6.0 (patch is not needed for Portal Server 6.1) configured on Secure Sockets Layer (SSL)—for information on deployments in an SSL environment, see Step 6 in the section, “Installation Steps.”
What the Installer Does
The installer:
- installs the following packages, SUNWpsso, SUNWpsap, SUNWpsmp, and SUNWpscp, which it deploys to the default Portal Server instance—for information on multi-server deployments, see "Multiple Instance Deployments."
- creates the channels, Address Book, Calendar, and Mail and places them into the My Front Page Tab panel container for the sample organization.
- creates and configures the single sign-on (SSO) Adapter service which enables single sign-on with the Sun ONE Calendar Server and Sun ONE Messaging Server.
Installation Steps
- Log in as root. You must have superuser privileges (that is, be logged in as root) to run the installation program.
- Create a directory (such as /tmp/ipcomm61) on the machine that will host Sun ONE Portal Server Communication Channels 6.0.
- Download the communication channels file, ps-comm_channels-6.0-us.sparc-sun-solaris8.zip, to the newly created directory.
- Change directories to the new directory.
- To extract the contents of the zipped file, type:
/usr/bin/unzip ps-comm_channels-6.0-us.sparc-sun-solaris8.zip
- For SSL deployments on Portal Server 6.0 (patch is not needed for Portal Server 6.1), install the patch that was downloaded with the communication channels (If this step doesn’t apply, skip this step and go to Step 7).
- From the same directory where you just unzipped the communications channels file, type:
./commsetup
- When the license agreement appears, if you agree, type:
Yes
It is necessary to agree to the license for the installation to continue.
- When the message appears, “What is the Identity Server administrative password,” enter that password.
If you are installing the communication channels on Portal Server 6.0, the installation ends here.The installation takes several minutes. If you are installing on Portal Server 6.1 continue to Step 10.
- When the message appears, “What is the Directory Managers password,” enter that password.
If you are installing on Portal Server 6.1 on a Web server, the installation ends here unless this is a Portal Server 6.1 SSL installation, then go to Step 12. If you are installing on Portal Server 6.1 on an application server you might see another message as explained in Step 11. If you do not see a message, the installation ends here unless this is a Portal Server 6.1 SSL installation, then go to Step 12.
- If you see a request for the application server password, enter that password.
The installation ends here unless this is a Portal Server 6.1 SSL installation, then go to Step 12.
- For SSL installations on Portal Server 6.1, you will need to restart the server by issuing the following commands:
BaseDir/SUNWam/bin/amserver stopall
BaseDir/SUNWam/bin/amserver startall- After the system prompts you for the password to get to the certificate database, enter the password. This prompt appears each time you restart the web server. The installation ends here.
Multiple Instance Deployments
If you have a multi Portal Server deployment, manually deploy the communication channels to each additional instance of Portal Server and restart each instance. To deploy, type:
BaseDir/SUNWps/bin/deploy redeploy -instance instancename
IS_ADMIN_PASSWORDWhere instancename is the name for that particular non-default instance and IS_ADMIN_PASSWORD is the password for the Identity Server at your site.
Code Example 2-1 lists the commands for manually deploying communication channels to two non-default Portal Server instances and for restarting those instances, where myinstance1 and myinstance2 are non-default Portal Server instance names and Admin is the identity Server password.
Configuring the Services for the Default OrganizationAfter the communication channels have been installed, the Calendar and Mail channels have sample or default settings that work without further configuration by an administrator. However, the Address Book requires more detailed configuration.
This section provides information about Single Sign-on (SSO) Adapter templates and SSO Adapter configurations. These templates and configurations affect the display of the communication channels on users’ portal desktops. To alter the display profile of users for the communication channels, you will need to edit or create SSO Adapter templates and configurations.
This chapter only discusses templates and configurations for Address Book. Even for Address Book, the discussion here is very specific. For a broader explanation of SSO Adapters, SSO Adapter templates, and SSO Adapter configurations, see Appendix A, "SSO Adapter Templates and Configurations."
To configure address book service defaults
- From an Internet browser, log on to the Identity Server administration console at http://hostname:port/amconsole, for example http://psserver.company22.siroe.com:80/amconsole
- Select Service Management in the View drop down list.
- Scroll down the lower left frame to Single Sign-on Adapter Configuration and click the arrow next to SSO Adapter.
- After the SSO Adapter page appears in the lower right frame, click the string that starts with the protocol Lightweight Directory Access Protocol (LDAP):
ldap://
This string appears among other strings, such as “pop3:///...”,“imap:///”, and “http:///.” They are in the box labeled SSO Adapter Templates under the heading Global as opposed to Dynamic.
Clicking the “ldap://...” string selects the string and places a copy of it in the field below—the configuration description field—allowing you to edit the string.
- With the “ldap://...” string showing in the configuration description field—which is just above Add and Remove buttons—click inside the field.
Code Example 2-2 displays the complete default SSO Adapter Template string as it appears in the configuration description field before editing. This description appears in the field as one long string; however, for readability purposes, it has been divided here into separate lines where line breaks have been added preceding each ampersand (&).
Code Example 2-2 Address Book SSO Adapter Template Before Editing
ldap://[SERVER-NAME:PORT]/?configName=[CONFIGURATION-NAME]
&pabSearchBase=[PAB-SEARCH-BASE]
&userSearchBase=[USER-SEARCH-BASE]
&aid=[ADMIN-ID]
&adminPassword=[ADMIN-PASSWORD]
&imapHost=[IMAP-HOST]
&imapPort=[IMAP-PORT]
&clientPort=[CLIENT-PORT]
&ssoClassName=com.sun.ssoadapter.impl.LDAPABSSOAdapter
&encoded=password
&default=ssoClassName
&default=host
&default=pabSearchBase
&default=userSearchBase
&default=aid
&default=adminPassword
&default=imapHost
&default=imapPort
&default=clientPort
&merge=uid
&merge=password
- In the configuration description field, replace the bracketed values in the string as detailed in Table 2-1 by selecting a bracketed value, such as [SERVER-NAME:PORT] and typing the specific replacement information, such as psserver.company22.siroe.com:389.
- After replacing all the bracketed values in the string, click Add.
This action places your newly edited “ldap://...” string in the SSO Adapter Template box among the other strings, including the original “ldap://...” string.
- If the original “ldap://...” string—the string with the bracketed values—is not currently selected, select it now. Ensure that it is the only string selected.
- Click Remove to remove the original “ldap://...” string.
- Scroll down the SSO Adapter page and click Save.
Refer to the Sun ONE Messaging Server 5.2 Administrator’s Guide for information on the parameters in the configuration description string:
http://docs.sun.com/source/816-6009-10/
Table 2-1 Details of the Address Book SSO Adapter Template String Example
Parameter
Value
SERVER-NAME: PORT
Replace this string with the name and port number of the user or group directory server associated with the messaging server. For example:
psserver.company22.siroe.com:389
The server name you enter to replace SERVER-NAME in the bracketed value [SERVER-NAME:PORT] is usually the same server name you enter to replace the bracketed value [IMAP-HOST].
Though unlikely, it is possible for these two hosts to be different. They might be different if a different IMAP host has been designated as one whose authentication applies to Personal Address Book (PAB).
To change the port number from 389 to another number, such as 390:
1. Enter 390 to replace PORT in the bracketed value [SERVER-NAME:PORT]. The server name and port example given at the beginning of this table would then appear as follows:
psserver.company22.siroe.com:390
2. Append the following to the Address Book SSO Adapter template string:
&default=port&port=390
This action would change the template string shown in Code Example 2-2 to end as follows:
...merge=uid&merge=password&default=port&port=390
CONFIGURATION_NAME
Replace this string with the following word:
pab
It is the same value that appears in the Dynamic SSO Adapter configurations as: configDesc=pab
Specifically, It appears in the following string:
undef:///?configName=ldapPab&configDesc=pab
PAB-SEARCH-BASE
Replace this string with the PAB search base. The search base is the point from which the Personal Address Book search should begin.
For example: o=pab.
USER-SEARCH -BASE
Replace this string with the user search base.
For example: o=siroe.com
ADMIN-ID:
Replace this string with the PAB LDAP administrator’s distinguished name (DN).
For example:
=uid=msg-admin,ou=People, o=company22.siroe.com,o=siroe.com
ADMIN-PASSWORD
Replace this string with the password for the PAB Admin ID. For example: admin
However, this is not an encrypted password. For information on how to use an encrypted password for the adminPassword, see Appendix A “SSO Adapter Templates and Configurations,” the entry titled “encoded” in Table 2-3.
IMAP-HOST
Replace this string with the Internet Messaging Access Protocol (IMAP) host name of the Messaging Server with the appropriate value.
For example:
psserver.company22.siroe.com
The name of this server is usually the same as the one used for [SERVER-NAME: PORT].
IMAP-PORT
Replace this string with the IMAP port number. For example: 143
CLIENT-PORT:
Replace this string with the HTTP number on which Messenger Express server is running.
For example: 1080
The configuration details after replacing the values in the Address Book SSO Adapter Template string appear as follows:
Code Example 2-3 Address Book SSO Adapter Template After Editing
ldap://company22.siroe.com/?configName=pab
&pabSearchBase=o=pab
&userSearchBase=o=siroe.com
&aid=uid=msg-admin,ou=People,o=company22.siroe.com,o=siroe.com
&adminPassword=admin
&imapHost=imserver.company22.siroe.com
&imapPort=143
&clientPort=1080
&ssoClassName=com.sun.ssoadapter.impl.LDAPABSSOAdapter
&encoded=password
&default=ssoClassName
&default=host
&default=pabSearchBase
&default=userSearchBase
&default=aid
&default=adminPassword
&default=imapHost
&default=imapPort
&default=clientPort
&merge=uid
&merge=password
Creating a New User Under the Default Organization
- Select User Management in the View drop down list, if it is not already selected.
- Click the organization link. For example: siroe.com.
- In the lower left frame, select Users in the Show drop down list.
- Click New.
- In the Create User panel, select the services to be assigned to the user.
Select at a minimum Desktop and SSO Adapter.
- Click Next.
- Enter the user information in the Create User panel.
- Click Create.
The new user’s name appears in the lower left frame under the column titled Name.
Configuring the Channel Settings
- Log into the Portal Server desktop as the new user:
- Click the Edit icon of each channel to configure the server settings.
- To configure the Mail channel settings:
Server Name. Enter the host name of the mail server. For example, mailserver.siroe.com.
IMAP Server Port. Enter the mail server port number.
SMTP Server Name. Enter the name of the Domain Name Server (DNS) of the outgoing mail—Simple Mail Transfer Protocol (SMTP)— server.
Client Port. Enter the port number configured for http service.
User Name. Enter the mail server user name.
User Password. Enter the mail server user password.
When sending a message place a copy in Sent Folder. Check this box to store copies of your outgoing messages in the Sent folder.
Finished. Click this button to save the mail configuration.
- To configure Address Book channel settings:
The IMAP user ID and Password are the same as the User Name and User Password entered when configuring the mail channel settings. For details, refer to the previous bulleted item, "To configure the Mail channel settings:".
IMAP User ID. Enter your IMAP User ID.
IMAP Password. Enter you IMAP Password.
Finished. Click this button to save the server information.
Cancel. Click this button to close the window without saving the details.
- To configure the Calendar channel settings:
Server Name. Enter the calendar server host name. For example, Calserver.siroe.com.
Server Port. Enter the calendar server port number.
User Name. Enter the calendar server user name.
User Password. Enter the calendar server user password.
Finished. Click this button to save the calendar configuration.
Cancel. Click this button to close the window without saving the details.
Note
The Address Book, Calendar, and Mail channels each have display options that can be set by the user and by default cannot be overwritten by an administrator. After logging into the desktop, the user can change the display options for a channel by clicking the edit button in the panel for that channel. The display options are clearly marked and easily changed.
In Address Book, a display option that users can change is the Number of Entries option; in Calendar, a display option that users can change is the Display Day View option; in Mail, a display option that users can change is the Number of Headers option.
Changes made by users to the default communication channels display options take precedence. Any future changes made by administrators will not automatically take effect and a new channel added by administrators will not automatically be accessible by users. To make administrators’ changes visible and accessible by users, go to "Some Users Won’t See Configuration Changes" for more information.