Collaborative Components samples

---

The Collaborative Components - including the API, the Javadoc, and the JSP samples - are installed when you install WebSphere Portal. The Sample Collaborative Components enterprise application file (cs.ear) demonstrates how collaborative functionality can be developed and/or added to your portal and portlets.

Note The samples in the Collaborative Components enterprise application have been tested only on the Windows platform.

This sample enterprise application includes Java methods and JSP tags for creating custom portlets or extending the functionality of existing portlets to include advanced collaborative features of the Lotus Software companion products.

• Provided samples
• Deploying Collaborative Components samples
• Configure Collaborative Components samples
• Example 1: Enabling People Awareness/Sametime Service
• Example 2: Enabling QuickPlace Service
• Example 3: Enabling LDAP sample

 

Provided samples

The cs.ear file provides a number of Collaborative Components samples, including the following:

• DominoService samples

  • dbpicksamp.jsp (Domino Directory sample: Selection lists for Servers, Databases, and Views)
  • viewsamp.jsp (Notes View sample: Add collaborative features to Notes database views, launch columns and people links)
  • calsamp.jsp (Notes Calendar view sample: Add collaborative features to a Notes Calendar view )
  • dbdocsamp.jsp (Notes Document sample: Add a document to a Notes database)
  • dbsamp.jsp (Domino Database sample: Create a Domino database)

• QPService (QuickPlace Service) sample

  • qpsamp.jsp (Create a QuickPlace)

• DiscoveryServerService sample

  • dssamp.jsp (shows Discovery Server functionality including profile and K-Map)

• Person tag sample

  • psamp.jsp (Add online awareness and person menus to create people links for named people)

• Menu tag sample

  • msamp.jsp

• Domino LDAP sample

  • ldapsamp.jsp

 

Deploying Collaborative Components samples

To deploy the Collaborative Components samples to WebSphere Portal:

1. Make sure that SSO is enabled on the server where the Collaborative Components enterprise application (cs.ear) is installed -- either the WebSphere Application Server or on WebSphere Portal.
2. Open the Administrative Console.
3. Under Applications on the left side of the console, select Install New Application.
4. Under Path, specify the location of the cs.ear file. The default server location is:

   installation_drive>:\WebSphere\PortalServer\InstallableApps\cs.ear

5. Click Next to accept defaults in the series of screens that follow.
6. Under Step 2, if necessary, specify a Virtual Host.
7. Click Finish.
8. Click Save to Master Configuration and then click Save again.

Once the samples are deployed and configured as described in Configure Collaborative Components samples, they appear under Enterprise Applications in the console, and you can launch them from WebSphere Portal using URLs such as the following:

http://<portalserveraddress>:9080/cs/index.jsp

 

Configure Collaborative Components samples

1. Use a text editor, edit the CSEnvironment.properties file located in the following directory:

   <AppServer>\installedApp\<servername>\cs.ear\cs.war\config\CSEnvironment.properties

2. Set the following value:

   CS_SERVER_WEBSPHERE_PORTAL_EXTEND.enabled=false
   

3. For each of the services listed in CSEnvironment.properties, do all of the following:

   • Enable the service.
   • Specify the appropriate information for the service or sample you're configuring (such as hostname, protocol, port, and so on). See the following examples for People Awareness/Sametime, QuickPlace, and LDAP.
   • Accept defaults for all optional and/or custom configuration settings.

4. Save the CSEnvironment.properties file.
5. Stop and start the Collaborative Components (CS) enterprise application (in the WebSphere Application Server administration console).

Example 1: Enabling People Awareness/Sametime Service

You will need to supply the following information:

##############################################################

#

# SAMETIME properties

# If Sametime is enabled, the required settings must be filled in.

###############################################################

# Required settings

#

CS_SERVER_SAMETIME.enabled=true

CS_SERVER_SAMETIME_1.hostname=ksg10.lotus.com

CS_SERVER_SAMETIME_1.version=3.0

# The protocol and port that the ST server uses 

# to serve up HTML, CSS and JavaScript files, etc.

CS_SERVER_SAMETIME_1.protocol=http

CS_SERVER_SAMETIME_1.port=80

Example 2: Enabling QuickPlace Service

You will need to supply the following information:

##############################################################

#

# QUICKPLACE properties

# enabled indicates whether or not QP creation is allowed.

##############################################################

CS_SERVER_QUICKPLACE.enabled=true

CS_SERVER_QUICKPLACE_1.hostname=ksg30.lotus.com

CS_SERVER_QUICKPLACE_1.version=3.0

CS_SERVER_QUICKPLACE_1.protocol=http

CS_SERVER_QUICKPLACE_1.port=80	

Example 3: Enabling LDAP sample

You will need to supply the following information:

##############################################################

#

# LDAP properties

# enabled indicates whether or not LDAP creation is allowed.

##############################################################

CS_SERVER_DOMINO_DIRECTORY.enabled=true

CS_SERVER_DOMINO_DIRECTORY_1.hostname=my.server.com

CS_SERVER_DOMINO_DIRECTORY_1.port=389 

CS_SERVER_DOMINO_DIRECTORY_1.ssl=false

 

See also

• Collaboration
• Collaborative Components API
• Planning for collaboration
• People awareness