Sun Java System Portal Server 7 Enterprise Sample Guide

Chapter 6 Setting up the Communications Tab

This chapter contains the following:

Introduction to Communication Services

The Communications tab available with the Enterprise Sample showcases the Java Enterprise System Communication Services.

Communication Products

The Communication Services are presented in the desktop via a series of channels that retrieve and display content from the following Communication products:

Communications Tab Channels

Address Book

Displays a list of contacts and launches the Communications Express client

Calendar

Displays a list of today's events and launches the Communications Express client

Find an Employee

Search for employees

Instant Messaging

Displays online contacts and launches the Instant Messenger client

Mail

Displays mail messages and launches the Communications Express client

Tasks

Displays tasks, including overdue tasks, and launches the Communications Express client

Installing the Enterprise Sample Portal Communications Tab

The Communications tab must be installed by the administrator after the Enterprise Sample has been installed and the Installation Prerequisites have been completed.

Installation Prerequisites

The Enterprise Sample Communications tab setup is dependent on the Delegated Administrator Utility, specifically the commadmin command line utility. The Delegated Administrator Utility is a Java Enterprise System supported mechanism for granting Domain and User level mail and calendar privileges. Please refer to Sun Java System Communications Services 6 2005Q4 Delegated Administrator Guide for more information.

The portal host must contain the following Java Enterprise System 2005Q4 installed and configured products:

In addition, the following Java Enterprise System 2005Q4 products need to be installed and configured and may exist on a different host than Portal Server 7:

The Communication Products (Messaging Server, Calendar Server, Delegated Administrator, Instant Messaging Server, and Communications Express) need to be configured for:

Installing the Communications Tab

The Communications tab is, by default, installed under the My Portal tab in the Enterprise Sample portal desktop. The Communications tab must be installed by the administrator using ant.

ProcedureTo Install the Communications Tab

Steps
  1. Copy the sample portal configuration files to a custom directory.

    The Enterprise Sample Communications tab setup depends on the following files:

    • input.properties

    • password.properties

    • comms.properties

    Copy the template files from PortalServer-base/samples/portals/shared directory to a custom directory, remove the .template extension, and substitute the tokens in each file. For example, type:


    mkdir /tmp/mydir
    cp /opt/SUNWportal/samples/portals/shared/password.properties.template /tmp/mydir/password.properties
    cp /opt/SUNWportal/samples/portals/shared/comms.properties.template /tmp/mydir/comms.properties
    cp /opt/SUNWportal/samples/portals/shared/input.properties.template /tmp/mydir/input.properties
    OR
    cp /var/opt/SUNWportal/tmp/input.properties /tmp/mydir/input.properties 
  2. Specify values for the following files:

    input.properties

    Edit the input.properties file and replace all the tokens that begin and end with % with the appropriate portal settings.


    Note –

    When the portal is configured, a populated input.properties file is available at PortalServer-DataDir/tmp/ directory.


    password.properties

    Edit the password.properties file and replace all the tokens that begin and end with % with the appropriate administrator password value.

    comms.properties

    Edit the comms.properties file and replace all the tokens that begin and end with % with the appropriate Communication Server setting.

    If all Java Enterprise System products have been installed on a single host, then there is a helper ant script to gather the Communication Product's information and generate the comms.properties file. The helper ant script,PortalServer-base/samples/portals/enterprise/singleHostGatherCommConfig.xml, usage is:


    ant -buildfile /opt/SUNWportal/samples/portals/enterprise/singleHostGatherCommConfig.xml -Doutput.location=outputlocation
    

    Where

    ant

    Refers to the ant script.

    outputlocation

    Refers to the location of the generated comms.properties file.

    For example:


    /usr/sfw/bin/ant -buildfile /opt/SUNWportal/samples/portals/enterprise/singleHostGatherCommConfig.xml -Doutput.location=/tmp/mydir

    This command will generate the comms.properties file in the directory specified by the output.location. Please review the settings in the comms.properties file before installing the communications tab.

  3. Run the ant script to install the Communications tab.

    This step installs or configures the Communications tab in the Enterprise Sample. The result of this step is a fully configured Communications tab with sample data for each channel: address book, mail, tasks, calendar, and instant messaging.

    To install, execute the command:


    ant config_comms -buildfile PortalServer-base/samples/portals/enterprise/build.xml -Dconfig.location=configlocation -logfile logfile
    

    where

    ant

    Refers to the ant script.

    configlocation

    Refers to the location (directory) of the password.properties and comms.properties files.

    logfile

    Refers to the location of the generated ant logfile.

    For example, type:


    /usr/sfw/bin/ant config_comms -buildfile /opt/SUNWportal/samples/portals/enterprise/build.xml -Dconfig.location=/tmp/mydir -logfile /tmp/comms.log
  4. Restart the web container.

    At this point, the Communications tab is configured on the Enterprise Sample desktop under the My Portal tab.